Class: MsgUpdateUserApprovals<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:32

MsgUpdateUserApprovals represents the message for updating user approvals.

For a transfer to be successful, the transfer has to satisfy the following conditions:

• Be approved on the collection level
• Be approved by the recipient's incoming transfers (if not forcefully overriden by the collection)
• Be approved by the sender's outgoing transfers (if not forcefully overriden by the collection)
• The sender must have enough tokens to transfer
• All restrictions and challenges for each approval must be satisfied (merkle challenges, approved amounts, max num transfers, ...)

For successful execution, the user must have the necessary permissions to update the corresponding fields. If not, it will throw an error. Permissions are updated last, so any permissions checked are the permissions BEFORE the update.

To specify you would like to update a field, the corresponding update field must be set to true. If it is set to false, we ignore it.

Extends#

• BaseNumberTypeClass<MsgUpdateUserApprovals<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iMsgUpdateUserApprovals<T>

Constructors#

Constructor#

new MsgUpdateUserApprovals<T>(msg): MsgUpdateUserApprovals<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:51

Parameters#

msg#

iMsgUpdateUserApprovals<T>

Returns#

MsgUpdateUserApprovals<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

autoApproveAllIncomingTransfers?#

optional autoApproveAllIncomingTransfers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:47

The new auto approve all incoming transfers. Must have the necessary permissions to update.

Implementation of#

iMsgUpdateUserApprovals.autoApproveAllIncomingTransfers

---

autoApproveSelfInitiatedIncomingTransfers?#

optional autoApproveSelfInitiatedIncomingTransfers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:45

The new auto approve self initiated incoming transfers. Must have the necessary permissions to update.

Implementation of#

iMsgUpdateUserApprovals.autoApproveSelfInitiatedIncomingTransfers

---

autoApproveSelfInitiatedOutgoingTransfers?#

optional autoApproveSelfInitiatedOutgoingTransfers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:43

The new auto approve self initiated outgoing transfers. Must have the necessary permissions to update.

Implementation of#

iMsgUpdateUserApprovals.autoApproveSelfInitiatedOutgoingTransfers

---

collectionId#

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:37

The ID of the collection to transfer tokens from.

Implementation of#

iMsgUpdateUserApprovals.collectionId

---

creator#

creator: string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:36

The creator of the transaction.

Implementation of#

iMsgUpdateUserApprovals.creator

---

incomingApprovals?#

optional incomingApprovals?: UserIncomingApproval<T>[]

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:41

The new incoming approvals. Must have the necessary permissions to update.

Implementation of#

iMsgUpdateUserApprovals.incomingApprovals

---

outgoingApprovals?#

optional outgoingApprovals?: UserOutgoingApproval<T>[]

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:39

The new outgoing approvals. Must have the necessary permissions to update.

Implementation of#

iMsgUpdateUserApprovals.outgoingApprovals

---

updateAutoApproveAllIncomingTransfers?#

optional updateAutoApproveAllIncomingTransfers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:46

Whether or not to update the auto approve all incoming transfers.

Implementation of#

iMsgUpdateUserApprovals.updateAutoApproveAllIncomingTransfers

---

updateAutoApproveSelfInitiatedIncomingTransfers?#

optional updateAutoApproveSelfInitiatedIncomingTransfers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:44

Whether or not to update the auto approve self initiated incoming transfers (i.e. to == the user and initiator == the user).

Implementation of#

iMsgUpdateUserApprovals.updateAutoApproveSelfInitiatedIncomingTransfers

---

updateAutoApproveSelfInitiatedOutgoingTransfers?#

optional updateAutoApproveSelfInitiatedOutgoingTransfers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:42

Whether or not to update the auto approve self initiated outgoing transfers (i.e. from == the user and initiator == the user).

Implementation of#

iMsgUpdateUserApprovals.updateAutoApproveSelfInitiatedOutgoingTransfers

---

updateIncomingApprovals?#

optional updateIncomingApprovals?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:40

Whether or not to update the incoming approvals.

Implementation of#

iMsgUpdateUserApprovals.updateIncomingApprovals

---

updateOutgoingApprovals?#

optional updateOutgoingApprovals?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:38

Whether or not to update the outgoing approvals.

Implementation of#

iMsgUpdateUserApprovals.updateOutgoingApprovals

---

updateUserPermissions?#

optional updateUserPermissions?: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:48

Whether or not to update the user permissions.

Implementation of#

iMsgUpdateUserApprovals.updateUserPermissions

---

userPermissions?#

optional userPermissions?: UserPermissions<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:49

The new user permissions. Must have the necessary permissions to update.

Implementation of#

iMsgUpdateUserApprovals.userPermissions

Methods#

clone()#

clone(): MsgUpdateUserApprovals

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

MsgUpdateUserApprovals

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): MsgUpdateUserApprovals<U>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:73

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

MsgUpdateUserApprovals<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

Type Parameters#

U#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:69

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): MsgUpdateUserApprovals<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:127

Parameters#

prefix#

string

Returns#

MsgUpdateUserApprovals<T>

---

toCosmWasmPayloadString()#

toCosmWasmPayloadString(): string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:138

Returns#

string

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

---

toProto()#

toProto(): MsgUpdateUserApprovals

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:77

Returns#

MsgUpdateUserApprovals

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): MsgUpdateUserApprovals<U>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:81

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MsgUpdateUserApprovals<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): MsgUpdateUserApprovals<U>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:89

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MsgUpdateUserApprovals<U>

---

fromProto()#

static fromProto<U>(protoMsg, convertFunction): MsgUpdateUserApprovals<U>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgUpdateUserApprovals.ts:97

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

MsgUpdateUserApprovals

convertFunction#

(item) => U

Returns#

MsgUpdateUserApprovals<U>