Skip to main content

GetCoinInfoResponse

@iota/grpc

@iota/grpc / GetCoinInfoResponse

Type Alias: GetCoinInfoResponse

GetCoinInfoResponse = Message<"iota.grpc.v1.state_service.GetCoinInfoResponse"> & object

Defined in: sdk/grpc/src/proto/iota/grpc/v1/state_service_pb.ts:238

Response message for StateService.GetCoinInfo.

Type Declaration​

coinType?​

optional coinType?: string

Required. The coin type.

Generated​

from field: optional string coin_type = 1;

metadata?​

optional metadata?: CoinMetadata

This field will be populated with information about this coin type's 0x2::coin::CoinMetadata if it exists and has not been wrapped.

Generated​

from field: optional iota.grpc.v1.coin.CoinMetadata metadata = 2;

regulatedMetadata?​

optional regulatedMetadata?: RegulatedCoinMetadata

If this coin type is a regulated coin, this field will be populated with information either from its Currency object in the CoinRegistry, or from its 0x2::coin::RegulatedCoinMetadata object for coins that have not been migrated to the CoinRegistry

If this coin is not known to be regulated, only the coin_regulated_state field will be populated.

Generated​

from field: optional iota.grpc.v1.coin.RegulatedCoinMetadata regulated_metadata = 4;

treasury?​

optional treasury?: CoinTreasury

This field will be populated with information about this coin type's 0x2::coin::TreasuryCap if it exists and has not been wrapped.

Generated​

from field: optional iota.grpc.v1.coin.CoinTreasury treasury = 3;

Generated​

from message iota.grpc.v1.state_service.GetCoinInfoResponse