web3-proxy/migration/src/m20220921_181610_log_reverts.rs

use sea_orm_migration::prelude::*;
use sea_orm_migration::sea_query::table::ColumnDef;

#[derive(DeriveMigrationName)]
pub struct Migration;

#[async_trait::async_trait]
impl MigrationTrait for Migration {
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        // add some fields to the UserKeys table
        manager
            .alter_table(
                sea_query::Table::alter()
                    .table(UserKeys::Table)
                    .to_owned()
                    // change requests per minute to a big_unsigned
                    .modify_column(
                        ColumnDef::new(UserKeys::RequestsPerMinute)
                            .big_unsigned()
                            .null(),
                    )
                    // add a column for logging reverts in the RevertLogs table
                    .add_column(
                        ColumnDef::new(UserKeys::LogRevertChance)
                            .decimal_len(5, 4)
                            .not_null()
                            .default("0.0"),
                    )
                    // add columns for more advanced authorization
                    .add_column(ColumnDef::new(UserKeys::AllowedIps).text().null())
                    .add_column(ColumnDef::new(UserKeys::AllowedOrigins).text().null())
                    .add_column(ColumnDef::new(UserKeys::AllowedReferers).text().null())
                    .add_column(ColumnDef::new(UserKeys::AllowedUserAgents).text().null())
                    .to_owned(),
            )
            .await?;

        // create a table for logging reverting eth_call and eth_estimateGas
        manager
            .create_table(
                Table::create()
                    .table(RevertLogs::Table)
                    .col(
                        ColumnDef::new(RevertLogs::Id)
                            .big_unsigned()
                            .not_null()
                            .auto_increment()
                            .primary_key(),
                    )
                    .col(
                        ColumnDef::new(RevertLogs::UserKeyId)
                            .big_unsigned()
                            .not_null(),
                    )
                    .col(ColumnDef::new(RevertLogs::Timestamp).timestamp().not_null())
                    .col(
                        ColumnDef::new(RevertLogs::Method)
                            .enumeration(
                                Alias::new("method"),
                                [
                                    Alias::new("eth_call"),
                                    Alias::new("eth_estimateGas"),
                                    Alias::new("eth_sendRawTransaction"),
                                ],
                            )
                            .not_null(),
                    )
                    .col(ColumnDef::new(RevertLogs::To).binary_len(20).not_null())
                    .col(ColumnDef::new(RevertLogs::CallData).text().null())
                    .index(sea_query::Index::create().col(RevertLogs::To))
                    .foreign_key(
                        sea_query::ForeignKey::create()
                            .from(RevertLogs::Table, RevertLogs::UserKeyId)
                            .to(UserKeys::Table, UserKeys::Id),
                    )
                    .to_owned(),
            )
            .await
    }

    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        // drop the new table
        manager
            .drop_table(Table::drop().table(RevertLogs::Table).to_owned())
            .await?;

        // put the UserKeys back to how it was before our migrations
        manager
            .alter_table(
                sea_query::Table::alter()
                    .table(UserKeys::Table)
                    .modify_column(
                        ColumnDef::new(UserKeys::RequestsPerMinute)
                            .unsigned()
                            .not_null(),
                    )
                    .drop_column(UserKeys::LogRevertChance)
                    .drop_column(UserKeys::AllowedIps)
                    .drop_column(UserKeys::AllowedOrigins)
                    .drop_column(UserKeys::AllowedReferers)
                    .drop_column(UserKeys::AllowedUserAgents)
                    .to_owned(),
            )
            .await
    }
}

// copied from create_table.rs, but added new columns
#[derive(Iden)]
pub enum UserKeys {
    Table,
    Id,
    // we don't touch some of the columns
    // UserId,
    // ApiKey,
    // Description,
    // PrivateTxs,
    // Active,
    RequestsPerMinute,
    LogRevertChance,
    AllowedIps,
    AllowedOrigins,
    AllowedReferers,
    AllowedUserAgents,
}

#[derive(Iden)]
enum RevertLogs {
    Table,
    Id,
    UserKeyId,
    Method,
    CallData,
    To,
    Timestamp,
}