Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(backend): add base field todos #14

Merged
merged 4 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions backend/src/core/bitcoin-api/bitcoin-api.schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export const Block = z.object({
difficulty: z.number(),
extras: z
.object({
reward: z.number(),
totalFees: z.number(),
avgFee: z.number(),
avgFeeRate: z.number(),
Expand Down
4 changes: 2 additions & 2 deletions backend/src/modules/bitcoin/address/address.dataloader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { NestDataLoader } from '@applifting-io/nestjs-dataloader';
import { Address } from 'src/core/bitcoin-api/bitcoin-api.schema';
import { BitcoinApiService } from 'src/core/bitcoin-api/bitcoin-api.service';
import { DataLoaderResponse } from 'src/common/type/dataloader';
import { BitcoinTransaction } from '../transaction/transaction.model';
import { BitcoinBaseTransaction, BitcoinTransaction } from '../transaction/transaction.model';

@Injectable()
export class BitcoinAddressLoader implements NestDataLoader<string, Address> {
Expand All @@ -29,7 +29,7 @@ export interface BitcoinAddressTransactionsLoaderProps {

@Injectable()
export class BitcoinAddressTransactionsLoader
implements NestDataLoader<BitcoinAddressTransactionsLoaderProps, BitcoinTransaction[]>
implements NestDataLoader<BitcoinAddressTransactionsLoaderProps, BitcoinBaseTransaction[]>
{
private logger = new Logger(BitcoinAddressTransactionsLoader.name);

Expand Down
2 changes: 1 addition & 1 deletion backend/src/modules/bitcoin/address/address.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ import { BitcoinAddressLoader, BitcoinAddressTransactionsLoader } from './addres
imports: [BitcoinApiModule],
providers: [BitcoinAddressResolver, BitcoinAddressLoader, BitcoinAddressTransactionsLoader],
})
export class AddressModule {}
export class BitcoinAddressModule {}
11 changes: 8 additions & 3 deletions backend/src/modules/bitcoin/address/address.resolver.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import DataLoader from 'dataloader';
import { Loader } from '@applifting-io/nestjs-dataloader';
import { Args, Float, Parent, ResolveField, Resolver } from '@nestjs/graphql';
import { BitcoinApiService } from 'src/core/bitcoin-api/bitcoin-api.service';
import { Args, Float, Parent, Query, ResolveField, Resolver } from '@nestjs/graphql';
import { BitcoinBaseTransaction, BitcoinTransaction } from '../transaction/transaction.model';
import { BitcoinAddress } from './address.model';
import {
Expand All @@ -14,7 +13,13 @@ import {

@Resolver(() => BitcoinAddress)
export class BitcoinAddressResolver {
constructor(private bitcoinApiService: BitcoinApiService) {}
@Query(() => BitcoinAddress, { name: 'btcAddress', nullable: true })
public async getBtcAddress(
@Loader(BitcoinAddressLoader) addressLoader: DataLoader<string, BitcoinAddress>,
@Args('address') address: string,
): Promise<BitcoinAddress> {
return await addressLoader.load(address);
}

@ResolveField(() => Float)
public async satoshi(
Expand Down
16 changes: 8 additions & 8 deletions backend/src/modules/bitcoin/bitcoin.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ import { Module } from '@nestjs/common';
import { BitcoinApiModule } from 'src/core/bitcoin-api/bitcoin-api.module';
import { BitcoinTransactionModule } from './transaction/transaction.module';
import { BitcoinResolver } from './bitcoin.resolver';
import { BlockModule } from './block/block.module';
import { AddressModule } from './address/address.module';
import { InputModule } from './input/input.module';
import { OutputModule } from './output/output.module';
import { BitcoinBlockModule } from './block/block.module';
import { BitcoinAddressModule } from './address/address.module';
import { BitcoinInputModule } from './input/input.module';
import { BitcoinOutputModule } from './output/output.module';

@Module({
imports: [
BitcoinApiModule,
BlockModule,
BitcoinBlockModule,
BitcoinTransactionModule,
AddressModule,
InputModule,
OutputModule,
BitcoinAddressModule,
BitcoinInputModule,
BitcoinOutputModule,
],
providers: [BitcoinResolver],
})
Expand Down
5 changes: 4 additions & 1 deletion backend/src/modules/bitcoin/block/block.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { BitcoinAddress } from '../address/address.model';

export type BitcoinBaseBlock = Omit<
BitcoinBlock,
'miner' | 'totalFee' | 'feeRateRange' | 'transactions'
'miner' | 'reward' | 'totalFee' | 'feeRateRange' | 'transactions'
>;

@ObjectType({ description: 'Fee Rate Range' })
Expand Down Expand Up @@ -49,6 +49,9 @@ export class BitcoinBlock {
@Field(() => BitcoinAddress)
miner: BitcoinAddress;

@Field(() => Float)
reward: number;

@Field(() => Float)
totalFee: number;

Expand Down
2 changes: 1 addition & 1 deletion backend/src/modules/bitcoin/block/block.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ import { BitcoinBlockResolver } from './block.resolver';
imports: [BitcoinApiModule],
providers: [BitcoinBlockResolver, BitcoinBlockLoader, BitcoinBlockTransactionsLoader],
})
export class BlockModule {}
export class BitcoinBlockModule {}
33 changes: 26 additions & 7 deletions backend/src/modules/bitcoin/block/block.resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,33 @@ export class BitcoinBlockResolver {
@ResolveField(() => BitcoinAddress)
public async miner(
@Parent() block: BitcoinBaseBlock,
@Loader(BitcoinBlockTransactionsLoader)
blockTxsLoader: DataLoader<string, BitcoinBlockTransactionsLoaderResponse>,
@Loader(BitcoinBlockLoader) blockLoader: DataLoader<string, BitcoinBlockLoaderResponse>,
): Promise<BitcoinBaseAddress> {
const txs = await blockTxsLoader.load(block.id);
const coinbaseTx = BitcoinTransaction.from(txs[0]);
return {
address: coinbaseTx.vout[0].scriptpubkeyAddress,
};
// XXX: only the "mempool" mode returns the "extra" field
const detail = await blockLoader.load(block.id);
if (detail.extras) {
return {
address: detail.extras.coinbaseAddress,
};
} else {
// TODO: what should be returned when using the "electrs" mode?
return null;
}
}

@ResolveField(() => Float)
public async reward(
@Parent() block: BitcoinBaseBlock,
@Loader(BitcoinBlockLoader) blockLoader: DataLoader<string, BitcoinBlockLoaderResponse>,
): Promise<number> {
// XXX: only the "mempool" mode returns the "extra" field
const detail = await blockLoader.load(block.id);
if (detail.extras) {
return detail.extras.reward;
} else {
// TODO: what should be returned when using the "electrs" mode?
return 0;
}
}

@ResolveField(() => Float)
Expand Down
4 changes: 2 additions & 2 deletions backend/src/modules/bitcoin/input/input.model.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Field, Float, ObjectType } from '@nestjs/graphql';
import * as BitcoinApi from 'src/core/bitcoin-api/bitcoin-api.schema';
import { BitcoinOutput } from '../output/output.model';
import { BitcoinBaseOutput, BitcoinOutput } from '../output/output.model';

@ObjectType({ description: 'Bitcoin Input' })
export class BitcoinInput {
Expand All @@ -11,7 +11,7 @@ export class BitcoinInput {
vout: number;

@Field(() => BitcoinOutput, { nullable: true })
prevout: BitcoinOutput;
prevout: BitcoinBaseOutput;

@Field(() => String)
scriptsig: string;
Expand Down
2 changes: 1 addition & 1 deletion backend/src/modules/bitcoin/input/input.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ import { BitcoinInputResolver } from './input.resolver';
@Module({
providers: [BitcoinInputResolver],
})
export class InputModule {}
export class BitcoinInputModule {}
7 changes: 6 additions & 1 deletion backend/src/modules/bitcoin/output/output.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import { Field, Float, ObjectType } from '@nestjs/graphql';
import * as BitcoinApi from 'src/core/bitcoin-api/bitcoin-api.schema';
import { BitcoinAddress, BitcoinBaseAddress } from '../address/address.model';

export type BitcoinBaseOutput = Omit<BitcoinOutput, 'spent'>;

@ObjectType({ description: 'Bitcoin Output' })
export class BitcoinOutput {
@Field(() => String)
Expand All @@ -22,7 +24,10 @@ export class BitcoinOutput {
@Field(() => BitcoinAddress, { nullable: true })
address: BitcoinBaseAddress;

public static from(output: BitcoinApi.Output) {
@Field(() => Boolean)
spent: boolean;

public static from(output: BitcoinApi.Output): BitcoinBaseOutput {
return {
scriptpubkey: output.scriptpubkey,
scriptpubkeyAsm: output.scriptpubkey_asm,
Expand Down
2 changes: 1 addition & 1 deletion backend/src/modules/bitcoin/output/output.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ import { BitcoinOutputResolver } from './output.resolver';
@Module({
providers: [BitcoinOutputResolver],
})
export class OutputModule {}
export class BitcoinOutputModule {}
6 changes: 6 additions & 0 deletions backend/src/modules/bitcoin/output/output.resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,10 @@ export class BitcoinOutputResolver {
address: output.scriptpubkeyAddress,
};
}

@ResolveField(() => Boolean)
public async spent(@Parent() output: BitcoinOutput): Promise<boolean> {
// TODO: implement this resolver
return false;
}
}
15 changes: 12 additions & 3 deletions backend/src/modules/bitcoin/transaction/transaction.model.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { Field, Float, Int, ObjectType } from '@nestjs/graphql';
import * as BitcoinApi from 'src/core/bitcoin-api/bitcoin-api.schema';
import { BitcoinInput } from '../input/input.model';
import { BitcoinOutput } from '../output/output.model';
import { BitcoinBaseOutput, BitcoinOutput } from '../output/output.model';

export type BitcoinBaseTransaction = BitcoinTransaction;
export type BitcoinBaseTransaction = Omit<BitcoinTransaction, 'confirmations'>;

@ObjectType({ description: 'Bitcoin Transaction' })
export class BitcoinTransaction {
Expand All @@ -23,7 +23,7 @@ export class BitcoinTransaction {
vin: BitcoinInput[];

@Field(() => [BitcoinOutput])
vout: BitcoinOutput[];
vout: BitcoinBaseOutput[];

@Field(() => Float)
size: number;
Expand All @@ -37,10 +37,18 @@ export class BitcoinTransaction {
@Field(() => Float)
fee: number;

@Field(() => Float)
feeRate: number;

@Field(() => Boolean)
confirmed: boolean;

@Field(() => Float)
confirmations: number;

public static from(tx: BitcoinApi.Transaction): BitcoinBaseTransaction {
const vSize = Math.ceil(tx.weight / 4);

return {
blockHeight: tx.status.block_height,
blockHash: tx.status.block_hash,
Expand All @@ -52,6 +60,7 @@ export class BitcoinTransaction {
locktime: new Date(tx.locktime),
weight: tx.weight,
fee: tx.fee,
feeRate: tx.fee / vSize,
confirmed: tx.status.confirmed,
};
}
Expand Down
16 changes: 15 additions & 1 deletion backend/src/modules/bitcoin/transaction/transaction.resolver.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import DataLoader from 'dataloader';
import { Args, Query, Resolver } from '@nestjs/graphql';
import { Args, Float, Parent, Query, ResolveField, Resolver } from '@nestjs/graphql';
import { Loader } from '@applifting-io/nestjs-dataloader';
import { BitcoinApiService } from '../../../core/bitcoin-api/bitcoin-api.service';
import { BitcoinBaseTransaction, BitcoinTransaction } from './transaction.model';
import {
BitcoinTransactionLoader,
Expand All @@ -9,6 +10,8 @@ import {

@Resolver(() => BitcoinTransaction)
export class BitcoinTransactionResolver {
constructor(private bitcoinApiService: BitcoinApiService) {}

@Query(() => BitcoinTransaction, { name: 'btcTransaction', nullable: true })
public async getTransaction(
@Args('txid') txid: string,
Expand All @@ -18,4 +21,15 @@ export class BitcoinTransactionResolver {
const transaction = await transactionLoader.load(txid);
return BitcoinTransaction.from(transaction);
}

@ResolveField(() => Float)
public async confirmations(@Parent() transaction: BitcoinTransaction): Promise<number> {
if (!transaction.confirmed) {
return 0;
}

// TODO: should this resolver be refactored with a dataloader?
const info = await this.bitcoinApiService.getBlockchainInfo();
return info.blocks - transaction.blockHeight + 1;
}
}
25 changes: 25 additions & 0 deletions backend/src/modules/ckb/address/address.model.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Field, Float, ObjectType } from '@nestjs/graphql';
import { CkbTransaction } from '../transaction/transaction.model';

export type CkbBaseAddress = Pick<CkbAddress, 'address'>;

@ObjectType({ description: 'CKB Address' })
export class CkbAddress {
@Field(() => String)
address: string;

@Field(() => Float)
shannon: number;

@Field(() => Float)
transactionCount: number;

@Field(() => [CkbTransaction])
transactions: CkbTransaction[];

public static from(address: string): CkbBaseAddress {
return {
address,
};
}
}
9 changes: 9 additions & 0 deletions backend/src/modules/ckb/address/address.module.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Module } from '@nestjs/common';
import { BitcoinApiModule } from 'src/core/bitcoin-api/bitcoin-api.module';
import { CkbAddressResolver } from './address.resolver';

@Module({
imports: [BitcoinApiModule],
providers: [CkbAddressResolver],
})
export class CkbAddressModule {}
34 changes: 34 additions & 0 deletions backend/src/modules/ckb/address/address.resolver.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { Args, Float, Parent, Query, ResolveField, Resolver } from '@nestjs/graphql';
import { CkbTransaction } from '../transaction/transaction.model';
import { CkbAddress } from './address.model';

@Resolver(() => CkbAddress)
export class CkbAddressResolver {
@Query(() => CkbAddress, { name: 'ckbAddress', nullable: true })
public async getCkbAddress(@Args('address') address: string): Promise<CkbAddress> {
// TODO: implement this resolver
return null;
}

@ResolveField(() => Float)
public async shannon(@Parent() address: CkbAddress): Promise<number> {
// TODO: implement this resolver
return 0;
}

@ResolveField(() => Float)
public async transactionCount(@Parent() address: CkbAddress): Promise<number> {
// TODO: implement this resolver
return 0;
}

@ResolveField(() => [CkbTransaction])
public async transactions(
@Parent() address: CkbAddress,
@Args('page', { nullable: true }) page?: number,
@Args('pageSize', { nullable: true }) pageSize?: number,
): Promise<CkbTransaction[]> {
// TODO: implement this resolver
return [];
}
}
10 changes: 9 additions & 1 deletion backend/src/modules/ckb/block/block.model.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { toNumber } from 'lodash';
import { Field, Float, Int, ObjectType } from '@nestjs/graphql';
import * as CkbRpc from 'src/core/ckb-rpc/ckb-rpc.interface';
import { CkbAddress } from '../address/address.model';
import { FeeRateRange } from '../../bitcoin/block/block.model';
import { CkbTransaction } from '../transaction/transaction.model';

export type CkbBaseBlock = Omit<CkbBlock, 'totalFee' | 'transactions'>;
export type CkbBaseBlock = Omit<CkbBlock, 'totalFee' | 'feeRateRange' | 'miner' | 'transactions'>;

@ObjectType({ description: 'CKB Block' })
export class CkbBlock {
Expand All @@ -25,6 +27,12 @@ export class CkbBlock {
@Field(() => Float)
totalFee: number;

@Field(() => FeeRateRange)
feeRateRange: FeeRateRange;

@Field(() => CkbAddress)
miner: CkbAddress;

@Field(() => [CkbTransaction])
transactions: CkbTransaction[];

Expand Down
Loading
Loading