Support for Stacks 2.1 stx-transfer event memo field

[zone117x]

Closes #1276

Implements parsing, storing, and returning the memo field that can be included in Stacks 2.1 stx_transfer_event events when the stx-transfer-memo? Clarity2 function is used.

To test this, deploy a Clarity2 versioned-smart-contract with something like the contract code:

(stx-transfer-memo? 
  u60
  tx-sender
  'ST2X2FYCY01Y7YR2TGC2Y6661NFF3SMH0NGXPWTV5
  0x74657374206d656d6f206669656c64)

Note: you need to be able to construct and serialize a versioned-smart-contract, this PR adds that capability to stacks.js hirosystems/stacks.js#1341

The resulting tx will have a stx-transfer event with the associated memo, e.g.:

{
  "event_index": 0,
  "event_type": "stx_asset",
  "tx_id": "0x6b0f0d3a28693e834f90e95fb058a70922de778d189e64903f550328e6256520",
  "asset": {
    "asset_event_type": "transfer",
    "sender": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
    "recipient": "ST2X2FYCY01Y7YR2TGC2Y6661NFF3SMH0NGXPWTV5",
    "amount": "60",
    "memo": "0x74657374206d656d6f206669656c64"
  }
}

If the stx-transfer event does not have a memo field (e.g. from a Clarity1 stx-transfer? function), then the memo field will not be included in the response.

Examples

GET /extended/v1/tx/<tx_id>

{
  "tx_id": "0x6b0f0d3a28693e834f90e95fb058a70922de778d189e64903f550328e6256520",
  "nonce": 0,
  "fee_rate": "12345",
  "sender_address": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
  "sponsored": false,
  "post_condition_mode": "allow",
  "post_conditions": [],
  "anchor_mode": "any",
  "is_unanchored": false,
  "block_hash": "0x390e5ff80baaf8a8c2f1a7662969d16ead1b0b986e92ed1b649f6f6eb527adf8",
  "parent_block_hash": "0x0bcd6a598321d330f72b52a4698ebc3431ab72af82eae10909213630105f176f",
  "block_height": 14,
  "burn_block_time": 1660842957,
  "burn_block_time_iso": "2022-08-18T17:15:57.000Z",
  "parent_burn_block_time": 1660842956,
  "parent_burn_block_time_iso": "2022-08-18T17:15:56.000Z",
  "canonical": true,
  "tx_index": 1,
  "tx_status": "success",
  "tx_result": {
    "hex": "0x0703",
    "repr": "(ok true)"
  },
  "microblock_hash": "0x",
  "microblock_sequence": 2147483647,
  "microblock_canonical": true,
  "event_count": 1,
  "events": [
    {
      "event_index": 0,
      "event_type": "stx_asset",
      "tx_id": "0x6b0f0d3a28693e834f90e95fb058a70922de778d189e64903f550328e6256520",
      "asset": {
        "asset_event_type": "transfer",
        "sender": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
        "recipient": "ST2X2FYCY01Y7YR2TGC2Y6661NFF3SMH0NGXPWTV5",
        "amount": "60",
        "memo": "0x74657374206d656d6f206669656c64"
      }
    }
  ],
  "execution_cost_read_count": 1,
  "execution_cost_read_length": 1,
  "execution_cost_runtime": 316963,
  "execution_cost_write_count": 2,
  "execution_cost_write_length": 118,
  "tx_type": "smart_contract",
  "smart_contract": {
    "clarity_version": 2,
    "contract_id": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6.hello-world-contract",
    "source_code": "(stx-transfer-memo? u60 tx-sender 'ST2X2FYCY01Y7YR2TGC2Y6661NFF3SMH0NGXPWTV5 0x74657374206d656d6f206669656c64)"
  }
}

GET /extended/v1/tx/events?tx_id=<tx_id>

{
  "limit": 96,
  "offset": 0,
  "events": [
    {
      "event_index": 0,
      "event_type": "stx_asset",
      "tx_id": "0x6b0f0d3a28693e834f90e95fb058a70922de778d189e64903f550328e6256520",
      "asset": {
        "asset_event_type": "transfer",
        "sender": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
        "recipient": "ST2X2FYCY01Y7YR2TGC2Y6661NFF3SMH0NGXPWTV5",
        "amount": "60",
        "memo": "0x74657374206d656d6f206669656c64"
      }
    }
  ]
}

GET /extended/v1/address/<principal>/assets

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "event_index": 0,
      "event_type": "stx_asset",
      "tx_id": "0x6b0f0d3a28693e834f90e95fb058a70922de778d189e64903f550328e6256520",
      "asset": {
        "asset_event_type": "transfer",
        "sender": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
        "recipient": "ST2X2FYCY01Y7YR2TGC2Y6661NFF3SMH0NGXPWTV5",
        "amount": "60",
        "memo": "0x74657374206d656d6f206669656c64"
      }
    }
  ]
}

TODO:

• Unit tests

[github-actions]

🚀 Deployed on https://deploy-preview-1285--stacks-blockchain-api.netlify.app

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (stacks-2.1@7e5752a). Click here to learn what that means.
The diff coverage is n/a.

@@              Coverage Diff              @@
##             stacks-2.1    #1285   +/-   ##
=============================================
  Coverage              ?   77.00%           
=============================================
  Files                 ?      106           
  Lines                 ?    10133           
  Branches              ?     2197           
=============================================
  Hits                  ?     7803           
  Misses                ?     2221           
  Partials              ?      109           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[rafaelcr]

🏁

[blockstack-devops]

🎉 This PR is included in version 4.2.0-stacks-2.1.1 🎉

The release is available on:

• npm package (@stacks-2.1 dist-tag)
• npm package (@stacks-2.1 dist-tag)
• GitHub release

Your semantic-release bot 📦🚀