# Class: MsgTransferTokens\ Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:27](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L27) MsgTransferTokens represents a message to transfer tokens from one user to another. 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, ...) Note that the transfer transaction is atomic, meaning that either all transfers succeed or all fail. ## Extends - [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class)\<`MsgTransferTokens`\<`T`\>\> ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Implements - [`iMsgTransferTokens`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens)\<`T`\> ## Constructors ### Constructor > **new MsgTransferTokens**\<`T`\>(`msg`): `MsgTransferTokens`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:32](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L32) #### Parameters ##### msg [`iMsgTransferTokens`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens)\<`T`\> #### Returns `MsgTransferTokens`\<`T`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#constructor) ## Properties ### collectionId > **collectionId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:29](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L29) The ID of the collection to transfer tokens from. #### Implementation of [`iMsgTransferTokens`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens).[`collectionId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens#collectionid) *** ### creator > **creator**: `string` Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:28](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L28) The creator of the transaction. #### Implementation of [`iMsgTransferTokens`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens).[`creator`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens#creator) *** ### transfers > **transfers**: [`Transfer`](https://docs.bitbadges.io/sdk/reference/classes/transfer)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:30](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L30) The transfers to perform. #### Implementation of [`iMsgTransferTokens`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens).[`transfers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-msg-transfer-tokens#transfers) ## Methods ### clone() > **clone**(): `MsgTransferTokens` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:151](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L151) Deep copies the object and returns a new instance. #### Returns `MsgTransferTokens` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#clone) *** ### convert() > **convert**\<`U`\>(`convertFunction`, `options?`): `MsgTransferTokens`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:39](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L39) Converts the object to a different NumberType equivalent. #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### convertFunction (`item`) => `U` ##### options? [`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options) #### Returns `MsgTransferTokens`\<`U`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#convert) *** ### equals() > **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> #### Parameters ##### other [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined` ##### normalizeNumberTypes? `boolean` #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#equals) *** ### getNumberFieldNames() > **getNumberFieldNames**(): `string`[] Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:43](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L43) Internal helper method to convert the number fields of the object to a different NumberType equivalent. #### Returns `string`[] #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#getnumberfieldnames) *** ### hasNumberFields() > **hasNumberFields**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161) Checks if the object has number fields. #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#hasnumberfields) *** ### toBech32Addresses() > **toBech32Addresses**(`prefix`): `MsgTransferTokens`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:75](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L75) #### Parameters ##### prefix `string` #### Returns `MsgTransferTokens`\<`T`\> *** ### toCosmWasmPayloadString() > **toCosmWasmPayloadString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:83](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L83) #### Returns `string` *** ### toJson() > **toJson**(): `JsonObject` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139) Converts the object to a JSON object with all primitive types. #### Returns `JsonObject` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojson) *** ### toJsonString() > **toJsonString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143) Converts the object to a JSON string. #### Returns `string` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojsonstring) *** ### toProto() > **toProto**(): `MsgTransferTokens` Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:47](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L47) #### Returns `MsgTransferTokens` *** ### fromJson() > `static` **fromJson**\<`U`\>(`jsonValue`, `convertFunction`, `options?`): `MsgTransferTokens`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:51](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L51) #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### jsonValue `JsonValue` ##### convertFunction (`item`) => `U` ##### options? `Partial`\<`JsonReadOptions`\> #### Returns `MsgTransferTokens`\<`U`\> *** ### fromJsonString() > `static` **fromJsonString**\<`U`\>(`jsonString`, `convertFunction`, `options?`): `MsgTransferTokens`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:59](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L59) #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### jsonString `string` ##### convertFunction (`item`) => `U` ##### options? `Partial`\<`JsonReadOptions`\> #### Returns `MsgTransferTokens`\<`U`\> *** ### fromProto() > `static` **fromProto**\<`U`\>(`protoMsg`, `convertFunction`): `MsgTransferTokens`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts:67](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgTransferTokens.ts#L67) #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### protoMsg `MsgTransferTokens` ##### convertFunction (`item`) => `U` #### Returns `MsgTransferTokens`\<`U`\>