[Rosetta][Construction-API][Feature] memo handling for transactions

[shermanxiong]

Feature Request

Support optional memos in transactions when using Rosetta Construction API to build and submit transactions. I think the best place to put this would be in the metadata field when constructing a transaction. It could look something like this:

Example Flow

construction/preprocess

----------------------------------------------------------------
REQUEST
{
  "network_identifier": {
    "blockchain": "stacks",
    "network": "testnet"
  },
  "operations": [
    {
      "operation_identifier": {
        "index": 0
      },
      "type": "fee",
      "account": {
        "address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK"
      },
      "amount": {
        "value": "-180",
        "currency": {
          "symbol": "STX",
          "decimals": 6
        }
      }
    },
    {
      "operation_identifier": {
        "index": 1
      },
      "type": "token_transfer",
      "account": {
        "address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK"
      },
      "amount": {
        "value": "-10000",
        "currency": {
          "symbol": "STX",
          "decimals": 6
        }
      }
    },
    {
      "operation_identifier": {
        "index": 2
      },
      "related_operations": [
        {
          "index": 1
        }
      ],
      "type": "token_transfer",
      "account": {
        "address": "STRZBNYT2MAH5Q1F3WJBP21CNY7YX5F89R6ZPF3J"
      },
      "amount": {
        "value": "10000",
        "currency": {
          "symbol": "STX",
          "decimals": 6
        }
      }
    }
  ],
  "metadata": {
    "memo": "SAMPLE MEMO"
  },
  "max_fee": [
    {
      "value": "200",
      "currency": {
        "symbol": "STX",
        "decimals": 6
      },
      "metadata": {}
    }
  ],
  "suggested_fee_multiplier": 0
}

----------------------------------------------------------------
RESPONSE
{
  "options": {
    "fee": "-180",
    "sender_address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK",
    "type": "token_transfer",
    "token_transfer_recipient_address": "STRZBNYT2MAH5Q1F3WJBP21CNY7YX5F89R6ZPF3J",
    "amount": "10000",
    "symbol": "STX",
    "decimals": 6,
    "max_fee": "200",
    "size": 180,
    "memo": "SAMPLE MEMO"
  },
  "required_public_keys": [
    {
      "address": "SPZ8XG58T080YJ54TCHQ5D6ZTVYMMTWCDVA8VREK"
    }
  ]
}

construction/metadata

----------------------------------------------------------------
REQUEST
{
  "network_identifier": {
      "blockchain": "stacks",
      "network": "testnet"
  },
  "options": {
    "fee": "-180",
    "sender_address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK",
    "type": "token_transfer",
    "token_transfer_recipient_address": "STRZBNYT2MAH5Q1F3WJBP21CNY7YX5F89R6ZPF3J",
    "amount": "10000",
    "symbol": "STX",
    "decimals": 6,
    "max_fee": "20",
    "size": 180,
    "memo": "SAMPLE MEMO"
  }
}
----------------------------------------------------------------
RESPONSE
{
  "metadata": {
    "fee": "-180",
    "sender_address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK",
    "type": "token_transfer",
    "token_transfer_recipient_address": "STRZBNYT2MAH5Q1F3WJBP21CNY7YX5F89R6ZPF3J",
    "amount": "10000",
    "symbol": "STX",
    "decimals": 6,
    "max_fee": "200",
    "size": 180,
    "account_sequence": 0,
    "recent_block_hash": "0x7f53710ec3494a7dfa4681b1638f3defaa217c6d7dafa221a8bd74e4cbfec6fa",
    "memo": "SAMPLE MEMO"
  },
  "suggested_fee": [
    {
      "value": "180",
      "currency": {
        "symbol": "STX",
        "decimals": 6
      }
    }
  ]
}

construction/payloads

----------------------------------------------------------------
REQUEST
{
  "network_identifier": {
    "blockchain": "stacks",
    "network": "testnet"
  },
  "operations": [
    {
      "operation_identifier": {
        "index": 0,
        "network_index": 0
      },
      "related_operations": [],
      "type": "fee",
      "account": {
        "address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK"
      },
      "amount": {
        "value": "-180",
        "currency": {
          "symbol": "STX",
          "decimals": 6
        }
      }
    },
    {
      "operation_identifier": {
        "index": 1
      },
      "type": "token_transfer",
      "account": {
        "address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK"
      },
      "amount": {
        "value": "-10000",
        "currency": {
          "symbol": "STX",
          "decimals": 6
        }
      }
    },
    {
      "operation_identifier": {
        "index": 2
      },
      "related_operations": [
        {
          "index": 1
        }
      ],
      "type": "token_transfer",
      "account": {
        "address": "STRZBNYT2MAH5Q1F3WJBP21CNY7YX5F89R6ZPF3J"
      },
      "amount": {
        "value": "10000",
        "currency": {
          "symbol": "STX",
          "decimals": 6
        }
      }
    }
  ],
  "public_keys": [
    {
      "hex_bytes": "<PUBLIC KEY>",
      "curve_type": "secp256k1"
    }
  ],
  "metadata": {
    "fee": "-180",
    "sender_address": "ST3HNYGWJDF7BJ5A7BHS3YJK1A8Y8M2G4XGRV7CZK",
    "type": "token_transfer",
    "token_transfer_recipient_address": "STRZBNYT2MAH5Q1F3WJBP21CNY7YX5F89R6ZPF3J",
    "amount": "10000",
    "symbol": "STX",
    "decimals": 6,
    "max_fee": "200",
    "size": 180,
    "account_sequence": 0,
    "recent_block_hash": "0x7f53710ec3494a7dfa4681b1638f3defaa217c6d7dafa221a8bd74e4cbfec6fa",
    "memo": "SAMPLE MEMO"
  },
}
----------------------------------------------------------------
RESPONSE
the response will have the memo in the metadata field in the unsigned_transaction 

One question is: could a stack-stx transaction also have a memo attached to it? if so then, we would like to allow optionality to include it as well as token_transfer

[zone117x]

We can add memo to the token_transfer operation, but not the others. There's no memo (or other free form field) that can be used for a stack-stx contract call.