bitbadgesjs-sdk - v0.5.43

bitbadgesjs-sdk - v0.5.43

Index

API

BaseBitBadgesApi BitBadgesAPI BitBadgesAdminAPI BitBadgesApiRoutes

API Requests / Responses

AddApprovalDetailsToOffChainStorageSuccessResponse AddBalancesToOffChainStorageSuccessResponse AddToIpfsSuccessResponse BatchBinActionSuccessResponse BroadcastTxSuccessResponse CalculatePointsSuccessResponse CheckSignInStatusSuccessResponse ClaimDetails CompleteClaimSuccessResponse CreateAddressListsSuccessResponse CreateAttestationSuccessResponse CreateClaimSuccessResponse CreateDeveloperAppSuccessResponse CreateDynamicDataBinSuccessResponse CreateGroupSuccessResponse CreatePaymentIntentSuccessResponse CreatePluginSuccessResponse CreateSIWBBRequestSuccessResponse DeleteAddressListsSuccessResponse DeleteAttestationSuccessResponse DeleteClaimSuccessResponse DeleteDeveloperAppSuccessResponse DeleteDynamicDataBinSuccessResponse DeleteGroupSuccessResponse DeletePluginSuccessResponse DeleteSIWBBRequestSuccessResponse EmptyResponseClass ExchangeSIWBBAuthorizationCodeSuccessResponse FetchMetadataDirectlySuccessResponse FilterBadgesInCollectionSuccessResponse FilterSuggestionsSuccessResponse GenerateAppleWalletPassSuccessResponse GenerateGoogleWalletSuccessResponse GenericBlockinVerifySuccessResponse GenericVerifyAssetsSuccessResponse GetAccountsSuccessResponse GetActiveAuthorizationsSuccessResponse GetAddressListsSuccessResponse GetAttestationsSuccessResponse GetBadgeActivitySuccessResponse GetBrowseSuccessResponse GetClaimAlertsForCollectionSuccessResponse GetClaimAttemptStatusSuccessResponse GetClaimsSuccessResponse GetCollectionByIdSuccessResponse GetCollectionsSuccessResponse GetDeveloperAppSuccessResponse GetDynamicDataActivitySuccessResponse GetDynamicDataBinsSuccessResponse GetExternalCallSuccessResponse GetGatedContentForClaimSuccessResponse GetGroupsSuccessResponse GetMapValuesSuccessResponse GetMapsSuccessResponse GetOwnersForBadgeSuccessResponse GetPluginSuccessResponse GetReservedClaimCodesSuccessResponse GetSIWBBRequestsForDeveloperAppSuccessResponse GetSearchSuccessResponse GetSignInChallengeSuccessResponse GetStatusSuccessResponse GetTokensFromFaucetSuccessResponse OauthRevokeSuccessResponse PerformBinActionBatchWithBodyAuthSuccessResponse PerformBinActionSingleWithBodyAuthSuccessResponse PerformBinActionSuccessResponse RefreshMetadataSuccessResponse RefreshStatusSuccessResponse RotateSIWBBRequestSuccessResponse SendClaimAlertsSuccessResponse SignOutSuccessResponse SimulateClaimSuccessResponse SimulateTxSuccessResponse UpdateAccountInfoSuccessResponse UpdateAddressListsSuccessResponse UpdateAttestationSuccessResponse UpdateClaimSuccessResponse UpdateDeveloperAppSuccessResponse UpdateDynamicDataBinSuccessResponse UpdateGroupSuccessResponse UpdatePluginSuccessResponse VerifyAttestationSuccessResponse VerifySignInSuccessResponse AddApprovalDetailsToOffChainStoragePayload AddBalancesToOffChainStoragePayload AddToIpfsPayload Attribute BatchBinActionPayload BinAction CalculatePointsPayload CheckSignInStatusPayload CompleteClaimPayload CosmosAccountResponse CosmosEvent CreateAddressListsPayload CreateAttestationPayload CreateClaimPayload CreateDeveloperAppPayload CreateDynamicDataBinPayload CreateGroupPayload CreatePaymentIntentPayload CreatePluginPayload CreateSIWBBRequestPayload DeleteAddressListsPayload DeleteAttestationPayload DeleteClaimPayload DeleteDeveloperAppPayload DeleteDynamicDataBinPayload DeleteGroupPayload DeletePluginPayload DeleteSIWBBRequestPayload ErrorResponse ExchangeSIWBBAuthorizationCodePayload FetchMetadataDirectlyPayload FilterBadgesInCollectionPayload FilterSuggestionsPayload GenerateAppleWalletPassPayload GenerateGoogleWalletPayload GenericBlockinVerifyPayload GenericVerifyAssetsPayload GetAccountsPayload GetActiveAuthorizationsPayload GetAdditionalCollectionDetailsPayload GetAddressListsPayload GetAttestationsPayload GetBadgeActivityPayload GetBadgeBalanceByAddressPayload GetBrowsePayload GetClaimAlertsForCollectionPayload GetClaimAttemptStatusPayload GetClaimsPayload GetCollectionByIdBody GetCollectionsPayload GetDeveloperAppPayload GetDynamicDataActivityPayload GetDynamicDataBinsPayload GetExternalCallPayload GetGatedContentForClaimPayload GetGroupsPayload GetMapValuesPayload GetMapsPayload GetMetadataForCollectionPayload GetOwnersForBadgePayload GetPluginPayload GetReservedClaimCodesPayload GetSIWBBRequestsForDeveloperAppPayload GetSearchPayload GetSignInChallengePayload GetStatusPayload GetTokensFromFaucetPayload MetadataFetchOptions OAuthScopeDetails OauthRevokePayload PerformBinActionBatchWithBodyAuthPayload PerformBinActionBodyAuthPayload PerformBinActionPayload PerformBinActionSingleWithBodyAuthPayload PluginVersionConfigPayload RefreshMetadataPayload RefreshStatusPayload RotateSIWBBRequestPayload SendClaimAlertsPayload SignOutPayload SimulateClaimPayload UpdateAccountInfoPayload UpdateAddressListsPayload UpdateAttestationPayload UpdateClaimPayload UpdateDeveloperAppPayload UpdateDynamicDataBinPayload UpdateGroupPayload UpdatePluginPayload VerifyAttestationPayload VerifySignInPayload iAddApprovalDetailsToOffChainStorageSuccessResponse iAddBalancesToOffChainStorageSuccessResponse iAddToIpfsSuccessResponse iBatchBinActionSuccessResponse iBroadcastTxSuccessResponse iCalculatePointsSuccessResponse iCheckSignInStatusSuccessResponse iCompleteClaimSuccessResponse iCreateAddressListsSuccessResponse iCreateAttestationSuccessResponse iCreateClaimSuccessResponse iCreateDeveloperAppSuccessResponse iCreateDynamicDataBinSuccessResponse iCreateGroupSuccessResponse iCreatePaymentIntentSuccessResponse iCreatePluginSuccessResponse iCreateSIWBBRequestSuccessResponse iDeleteAddressListsSuccessResponse iDeleteAttestationSuccessResponse iDeleteClaimSuccessResponse iDeleteDeveloperAppSuccessResponse iDeleteDynamicDataBinSuccessResponse iDeleteGroupSuccessResponse iDeletePluginSuccessResponse iDeleteSIWBBRequestSuccessResponse iExchangeSIWBBAuthorizationCodeSuccessResponse iFetchMetadataDirectlySuccessResponse iFilterBadgesInCollectionSuccessResponse iFilterSuggestionsSuccessResponse iGenerateAppleWalletPassSuccessResponse iGenerateGoogleWalletSuccessResponse iGenericBlockinVerifySuccessResponse iGenericVerifyAssetsSuccessResponse iGetAccountsSuccessResponse iGetActiveAuthorizationsSuccessResponse iGetAddressListsSuccessResponse iGetAttestationsSuccessResponse iGetBadgeActivitySuccessResponse iGetBadgeBalanceByAddressSuccessResponse iGetBrowseSuccessResponse iGetClaimAlertsForCollectionSuccessResponse iGetClaimAttemptStatusSuccessResponse iGetClaimsSuccessResponse iGetCollectionByIdSuccessResponse iGetCollectionsSuccessResponse iGetDeveloperAppSuccessResponse iGetDynamicDataActivitySuccessResponse iGetDynamicDataBinsSuccessResponse iGetExternalCallSuccessResponse iGetGatedContentForClaimSuccessResponse iGetGroupsSuccessResponse iGetMapValuesSuccessResponse iGetMapsSuccessResponse iGetOwnersForBadgeSuccessResponse iGetPluginSuccessResponse iGetReservedClaimCodesSuccessResponse iGetSIWBBRequestsForDeveloperAppSuccessResponse iGetSearchSuccessResponse iGetSignInChallengeSuccessResponse iGetStatusSuccessResponse iGetTokensFromFaucetSuccessResponse iOauthRevokeSuccessResponse iPerformBinActionBatchWithBodyAuthSuccessResponse iPerformBinActionSingleWithBodyAuthSuccessResponse iPerformBinActionSuccessResponse iPointsValue iRefreshMetadataSuccessResponse iRefreshStatusSuccessResponse iRotateSIWBBRequestSuccessResponse iSendClaimAlertsSuccessResponse iSignOutSuccessResponse iSimulateClaimSuccessResponse iSimulateTxSuccessResponse iUpdateAccountInfoSuccessResponse iUpdateAddressListsSuccessResponse iUpdateAttestationSuccessResponse iUpdateClaimSuccessResponse iUpdateDeveloperAppSuccessResponse iUpdateDynamicDataBinSuccessResponse iUpdateGroupSuccessResponse iUpdatePluginSuccessResponse iVerifyAttestationSuccessResponse iVerifySignInSuccessResponse AccountFetchDetails AccountViewKey BroadcastTxPayload CollectionViewKey SimulateTxPayload

Accounts

AccountDoc BitBadgesUserInfo CustomListPage CustomPage EmailVerificationStatus NotificationPreferences ProfileDoc SocialConnectionInfo SocialConnections

Address Lists

AddressList AddressListDoc BitBadgesAddressList generateReservedListId getOverlapDetails getReservedAddressList getReservedTrackerList

Address Utils

SupportedChain SupportedChainType convertToBitBadgesAddress convertToBtcAddress convertToEthAddress getAbbreviatedAddress getChainForAddress isAddressValid mustConvertToBitBadgesAddress mustConvertToBtcAddress mustConvertToEthAddress

Aliases

generateAlias getAliasDerivationKeysForBadge getAliasDerivationKeysForCollection getAliasDerivationKeysForList

Approvals / Transferability

AmountTrackerIdDetails ApprovalAmounts ApprovalCriteria ApprovalCriteriaWithDetails ApprovalIdentifierDetails ApprovalInfoDetails ApprovalTrackerDoc ChallengeDetails ChallengeInfoDetails ChallengeTrackerIdDetails CoinTransfer CollectionApproval CollectionApprovalWithDetails IncomingApprovalCriteria IncomingApprovalCriteriaWithDetails IncrementedBalances ManualBalances MaxNumTransfers MerkleChallenge MerkleChallengeDoc MerkleChallengeWithDetails MerklePathItem MerkleProof MustOwnBadges OutgoingApprovalCriteria OutgoingApprovalCriteriaWithDetails PredeterminedBalances PredeterminedOrderCalculationMethod Transfer TransferWithIncrements UsedLeafStatus UserIncomingApproval UserIncomingApprovalWithDetails UserOutgoingApproval UserOutgoingApprovalWithDetails ZkProof ZkProofSolution iUserOutgoingApprovalWithDetails appendSelfInitiatedIncomingApproval appendSelfInitiatedOutgoingApproval getMintApprovals getNonMintApprovals getUnhandledCollectionApprovals getUnhandledUserIncomingApprovals getUnhandledUserOutgoingApprovals validateCollectionApprovalsUpdate

Batch Utils

BatchBadgeDetails BatchBadgeDetailsArray

Chain Details

BETANET_CHAIN_DETAILS BitBadgesKeplrSuggestBetanetChainInfo BitBadgesKeplrSuggestTestnetChainInfo MAINNET_CHAIN_DETAILS TESTNET_CHAIN_DETAILS

Claims

PluginPresetType IntegrationPluginDetails IntegrationPluginParams ClaimIntegrationPluginCustomBodyType ClaimIntegrationPluginType ClaimIntegrationPrivateParamsType ClaimIntegrationPrivateStateType ClaimIntegrationPublicParamsType ClaimIntegrationPublicStateType JsonBodyInputSchema JsonBodyInputWithValue

Collections

BadgeMetadata BadgeMetadataDetails BitBadgesCollection CollectionDoc CollectionMetadata CollectionMetadataDetails Metadata

Hook Bins

Interfaces

iAccessTokenDoc iAccountDoc iActionPermission iActivityDoc iAddressList iAddressListDoc iAddressListEditKey iAirdropDoc iAmountTrackerIdDetails iApprovalAmounts iApprovalCriteria iApprovalCriteriaWithDetails iApprovalIdentifierDetails iApprovalInfoDetails iApprovalTrackerDoc iAttestation iAttestationDoc iAttestationsProof iBadgeIdsActionPermission iBadgeMetadata iBadgeMetadataDetails iBadgeMetadataTimeline iBadgeMetadataTimelineWithDetails iBalance iBalanceDoc iBalanceDocWithDetails iBatchBadgeDetails iBitBadgesAddressList iBitBadgesApi iBitBadgesCollection iBitBadgesUserInfo iChallengeDetails iChallengeInfoDetails iChallengeTrackerIdDetails iClaimActivityDoc iClaimAlertDoc iClaimBuilderDoc iClaimDetails iClaimReward iCoinTransfer iCollectionApproval iCollectionApprovalPermission iCollectionApprovalPermissionWithDetails iCollectionApprovalWithDetails iCollectionDoc iCollectionMetadata iCollectionMetadataDetails iCollectionMetadataTimeline iCollectionMetadataTimelineWithDetails iCollectionPermissions iCollectionPermissionsWithDetails iComplianceDoc iCosmosCoin iCustomDataTimeline iCustomLink iCustomListPage iCustomPage iDepositBalanceDoc iDeveloperAppDoc iDynamicDataDoc iEmailVerificationStatus iFetchDoc iGroupPage iIPFSTotalsDoc iIncomingApprovalCriteria iIncomingApprovalCriteriaWithDetails iIncrementedBalances iIndexerStatus iIsArchivedTimeline iLatestBlockStatus iListActivityDoc iManagerTimeline iManualBalances iMap iMapDoc iMapMetadataTimeline iMapPermissions iMapUpdateCriteria iMapWithValues iMaxNumTransfers iMerkleChallenge iMerkleChallengeDoc iMerkleChallengeWithDetails iMerklePathItem iMerkleProof iMetadata iMsgCreateAddressLists iMsgCreateCollection iMsgCreateMap iMsgDeleteCollection iMsgDeleteMap iMsgExecuteContractCompat iMsgInstantiateContractCompat iMsgSetValue iMsgStoreCodeCompat iMsgTransferBadges iMsgUniversalUpdateCollection iMsgUpdateCollection iMsgUpdateMap iMsgUpdateUserApprovals iMustOwnBadges iNotificationPreferences iOffChainBalancesMap iOffChainBalancesMetadata iOffChainBalancesMetadataTimeline iOutgoingApprovalCriteria iOutgoingApprovalCriteriaWithDetails iPluginDoc iPluginVersionConfig iPointsDoc iPredeterminedBalances iPredeterminedOrderCalculationMethod iProfileDoc iQueueDoc iRefreshDoc iReviewDoc iSIWBBRequestDoc iSetOptions iSiwbbChallenge iSocialConnections iStandardsTimeline iStatusDoc iTierWithOptionalWeight iTimedUpdatePermission iTimedUpdateWithBadgeIdsPermission iTimelineItem iTransfer iTransferActivityDoc iTransferWithIncrements iUintRange iUpdateHistory iUsedLeafStatus iUserBalanceStore iUserBalanceStoreWithDetails iUserIncomingApproval iUserIncomingApprovalPermission iUserIncomingApprovalPermissionWithDetails iUserIncomingApprovalWithDetails iUserOutgoingApproval iUserOutgoingApprovalPermission iUserOutgoingApprovalPermissionWithDetails iUserPermissions iUserPermissionsWithDetails iValueOptions iValueStore iZkProof iZkProofSolution ActionName BitBadgesAddress CreateClaimRequest DynamicDataHandlerActionPayload DynamicDataHandlerActionRequest DynamicDataHandlerData DynamicDataHandlerType GetCollectionRequestBody ManagePluginRequest NativeAddress SiwbbMessage UNIXMilliTimestamp UpdateClaimRequest iAddressListCreateObject

Maps

Map MapDoc MapMetadataTimeline MapPermissions MapUpdateCriteria MapWithValues ValueOptions ValueStore

Math

GO_MAX_UINT_64 bigIntMax bigIntMin castNumberType safeAdd safeAddKeepLeft safeAddKeepRight safeMultiply safeMultiplyKeepLeft safeMultiplyKeepRight safeSubtract safeSubtractKeepLeft safeSubtractKeepRight

Metadata IDs

getBadgeIdsForMetadataId getMaxMetadataId getMetadataIdForBadgeId getMetadataIdsForUri getUrisForMetadataIds

Number Types

JSPrimitiveNumberType NumberType BigIntify Numberify NumberifyIfPossible Stringify

OAuth

Off-Chain Attestations

Attestation AttestationDoc AttestationsProof

Other

BatchEntry BatchProof CommitmentProof CompressedBatchEntry CompressedBatchProof CompressedExistenceProof CompressedNonExistenceProof ExistenceProof HashOp InnerOp InnerSpec LeafOp LengthOp NonExistenceProof ProofSpec anchor badges bitcoin cosmos cosmos_proto cosmwasm ethereum google maps protocols solana tendermint wasmx proto BroadcastMode ProposalStatus AminoTypesClass AccountResponse AminoConverter BalancesResponse BitBadgesProfile BroadcastPostBody Channel ChannelsResponse CounterParty DelegationResponse DeliverTxResponse DistributionRewardsResponse EncodeObject GetDelegationsResponse GetUndelegationsResponse GetValidatorsResponse MergedUniversalPermissionDetails Overlap Proposal ProposalsResponse Reward TallyResponse TxToSend UndelegationResponse UniversalPermission UniversalPermissionDetails UsedFlags Validator iEvent iGroupDoc AminoConverters ActionPermissionUsedFlags AminoTypes ApprovalPermissionUsedFlags BadgeIdsActionPermissionUsedFlags ProtoTypeRegistry TimedUpdatePermissionUsedFlags TimedUpdateWithBadgeIdsPermissionUsedFlags BitBadgesNextAuth GetFirstMatchOnly GetListIdWithOptions GetListWithOptions GetUintRangesWithOptions MergeUniversalPermissionDetails ValidateUniversalPermissionUpdate convertAminoToProtoValue convertProtoMessageToObject convertProtoValueToDefaultAmino convertProtoValueToMessage convertSnakeKeysToCamel createAminoConverter createAnchorAminoConverters createBadgesAminoConverters createDefaultAminoConverters createDefaultCosmosAminoConverters createMapsAminoConverters createWasmXAminoConverters generateEndpointAccount generateEndpointBalances generateEndpointBroadcast generateEndpointDistributionRewardsByAddress generateEndpointGetDelegations generateEndpointGetUndelegations generateEndpointGetValidators generateEndpointIBCChannels generateEndpointProposalTally generateEndpointProposals generatePostBodyBroadcast getOverlapsAndNonOverlaps snakeToCamelCase universalRemoveOverlapFromValues universalRemoveOverlaps

Permissions

ActionPermission BadgeIdsActionPermission CollectionApprovalPermission CollectionApprovalPermissionWithDetails CollectionPermissions CollectionPermissionsWithDetails TimedUpdatePermission TimedUpdateWithBadgeIdsPermission UserIncomingApprovalPermission UserIncomingApprovalPermissionWithDetails UserOutgoingApprovalPermission UserOutgoingApprovalPermissionWithDetails UserPermissions UserPermissionsWithDetails PermissionNameString getPermissionVariablesFromName

Plugins

PluginDoc PluginVersionConfig

SIWBB

DeveloperAppDoc OwnershipRequirements SIWBBRequestDoc SiwbbAndGroup SiwbbAssetDetails SiwbbChallengeParams SiwbbOrGroup SiwbbAssetConditionGroup

SIWBB Authentication

SiwbbChallenge CodeGenQueryParams VerifySIWBBOptions createAttestationsProof generateBitBadgesAuthUrl verifyAttestation verifyAttestationsPresentationSignatures

Timelines

BadgeMetadataTimeline BadgeMetadataTimelineWithDetails CollectionMetadataTimeline CollectionMetadataTimelineWithDetails CustomDataTimeline IsArchivedTimeline ManagerTimeline OffChainBalancesMetadataTimeline StandardsTimeline TimelineItem getBadgeMetadataTimesAndValues getCollectionMetadataTimesAndValues getCurrentIdxForTimeline getCurrentValueForTimeline getCustomDataTimesAndValues getFullBadgeMetadataTimeline getFullCollectionMetadataTimeline getFullCustomDataTimeline getFullIsArchivedTimeline getFullManagerTimeline getFullStandardsTimeline getIdxAtTimeForTimeline getIsArchivedTimesAndValues getManagerTimesAndValues getOffChainBalancesMetadataTimeline getOffChainBalancesMetadataTimesAndValues getStandardsTimesAndValues getValueAtTimeForTimeline validateBadgeMetadataUpdate validateCollectionMetadataUpdate validateCustomDataUpdate validateIsArchivedUpdate validateManagerUpdate validateOffChainBalancesMetadataUpdate validateStandardsUpdate

Uint Ranges

UintRange UintRangeArray uintRangeArrsEqual

Utils

BaseNumberTypeClass CustomTypeClass ConvertOptions CustomType compareCustomTypes compareNumberTypeConvertibles convertClassPropertiesAndMaintainNumberTypes convertClassPropertiesToJson deepCopy deepCopyPrimitives getConverterFunction

Other

BatchEntry

Re-exports BatchEntry

BatchProof

Re-exports BatchProof

CommitmentProof

Re-exports CommitmentProof

CompressedBatchEntry

Re-exports CompressedBatchEntry

CompressedBatchProof

Re-exports CompressedBatchProof

CompressedExistenceProof

Re-exports CompressedExistenceProof

CompressedNonExistenceProof

Re-exports CompressedNonExistenceProof

ExistenceProof

Re-exports ExistenceProof

HashOp

Re-exports HashOp

InnerOp

Re-exports InnerOp

InnerSpec

Re-exports InnerSpec

LeafOp

Re-exports LeafOp

LengthOp

Re-exports LengthOp

NonExistenceProof

Re-exports NonExistenceProof

ProofSpec

Re-exports ProofSpec

anchor

Re-exports anchor

badges

Re-exports badges

bitcoin

Re-exports bitcoin

cosmos

Re-exports cosmos

cosmos_proto

Re-exports cosmos_proto

cosmwasm

Re-exports cosmwasm

ethereum

Re-exports ethereum

google

Re-exports google

maps

Re-exports maps

protocols

Re-exports protocols

solana

Re-exports solana

tendermint

Re-exports tendermint

wasmx

Re-exports wasmx