@carrot-foundation/schemas 0.1.61 → 0.1.62

package/dist/index.cjs

@@ -28434,10 +28434,6 @@ var BaseIpfsSchema = zod.z.strictObject({
   }),
   external_id: ExternalIdSchema,
   external_url: ExternalUrlSchema,
-  content_hash: Sha256HashSchema.meta({
-    title: "Content Hash",
-    description: "SHA-256 hash of RFC 8785 canonicalized JSON after schema validation"
-  }),
   viewer_reference: ViewerReferenceSchema.optional(),
   environment: RecordEnvironmentSchema.optional(),
   data: zod.z.record(zod.z.string(), zod.z.unknown()).optional().meta({
@@ -28548,9 +28544,9 @@ var NftIpfsSchema = BaseIpfsSchema.safeExtend({
       description: "Type/category of this NFT schema"
     })
   }),
-  full_content_hash: Sha256HashSchema.meta({
-    title: "Full Content Hash",
-    description: "SHA-256 hash of the original JSON content including private data before schema validation"
+  audit_data_hash: Sha256HashSchema.meta({
+    title: "Audit Data Hash",
+    description: "SHA-256 hash of the original JSON content including private data before schema validation, used for data audit purposes"
   }),
   viewer_reference: ViewerReferenceSchema,
   environment: RecordEnvironmentSchema,
@@ -29073,6 +29069,13 @@ var OriginCityAttributeSchema = NftAttributeSchema.safeExtend({
   title: "Origin City Attribute",
   description: "City or municipality where waste was originally generated and picked up"
 });
+var OriginCountrySubdivisionAttributeSchema = NftAttributeSchema.safeExtend({
+  trait_type: zod.z.literal("Origin Country Subdivision"),
+  value: IsoCountrySubdivisionCodeSchema
+}).meta({
+  title: "Origin Country Subdivision Attribute",
+  description: "ISO 3166-2 country subdivision code where waste was originally generated and picked up"
+});
 var AuditResultSchema = zod.z.enum(["PASSED", "FAILED"]).meta({
   title: "Audit Result",
   description: "Result of audit execution",
@@ -29099,7 +29102,7 @@ var AuditReferenceSchema = zod.z.strictObject({
     title: "Rules Executed",
     description: "Number of rules executed during the audit"
   }),
-  report_uri: IpfsUriSchema.meta({
+  ipfs_uri: IpfsUriSchema.meta({
     title: "Audit Report",
     description: "IPFS URI of the audit report"
   })
@@ -29435,7 +29438,7 @@ var WastePropertiesSchema = zod.z.strictObject({
     title: "Source Waste Subtype",
     description: "Subtype of the source waste"
   }),
-  net_weight_kg: WeightKgSchema.meta({
+  weight_kg: WeightKgSchema.meta({
     title: "Source Waste Net Weight",
     description: "Net weight of the source waste in kilograms (kg)"
   })
@@ -29443,102 +29446,6 @@ var WastePropertiesSchema = zod.z.strictObject({
   title: "Waste Properties",
   description: "Properties of the source waste (MassID)"
 });
-var RewardDiscountTypeSchema = zod.z.enum(["large_business", "supply_chain_digitization"]).meta({
-  title: "Discount Type",
-  description: "Type of discount applied to the reward allocation",
-  examples: ["large_business", "supply_chain_digitization"]
-});
-var RewardDiscountSchema = zod.z.strictObject({
-  type: RewardDiscountTypeSchema.meta({
-    title: "Discount Type",
-    description: "Type of discount applied"
-  }),
-  percentage: PercentageSchema.meta({
-    title: "Discount Percentage",
-    description: "Percentage reduction applied (e.g., 50 for 50% discount)",
-    examples: [25, 50]
-  }),
-  reason: NonEmptyStringSchema.max(200).meta({
-    title: "Discount Reason",
-    description: "Human-readable explanation of why the discount was applied",
-    examples: [
-      "Waste Generator not identified - Supply Chain Digitization Incentive",
-      "Large business with >$4M annual revenue",
-      "Brazil Tax Authority Group I Large Business classification"
-    ]
-  })
-}).meta({
-  title: "Discount",
-  description: "Discount applied to a reward allocation"
-});
-var RewardAllocationSchema = zod.z.strictObject({
-  participant_id_hash: ParticipantIdHashSchema,
-  role: ParticipantRoleSchema.meta({
-    title: "Participant Role",
-    description: "Role of the participant in the supply chain"
-  }),
-  reward_percentage: PercentageSchema.meta({
-    title: "Reward Percentage",
-    description: "Reward percentage allocated to the participant"
-  }),
-  discounts: zod.z.array(RewardDiscountSchema).optional().meta({
-    title: "Discounts",
-    description: "Discounts applied to this participant's reward allocation"
-  }),
-  effective_percentage: PercentageSchema.meta({
-    title: "Effective Percentage",
-    description: "Effective percentage of the reward after discounts"
-  })
-}).meta({
-  title: "Reward Allocation",
-  description: "Reward allocation for a specific participant"
-});
-var DistributionNotesSchema = zod.z.strictObject({
-  discounts_applied: zod.z.array(NonEmptyStringSchema.max(200)).optional().meta({
-    title: "Discounts Applied",
-    description: "Descriptions of discounts applied to the distribution",
-    examples: [
-      [
-        "50% reduction applied to Waste Generator participants with >$4M annual revenue",
-        "25% Supply Chain Digitization Incentive applied to logistics providers due to unidentified Waste Generator"
-      ]
-    ]
-  }),
-  redirected_rewards: NonEmptyStringSchema.max(300).optional().meta({
-    title: "Redirected Rewards",
-    description: "Description of rewards redirected to community pools or other recipients",
-    examples: [
-      "Discounted rewards from large businesses redirected to the Community Impact Pool managed by Carrot Foundation"
-    ]
-  }),
-  special_circumstances: zod.z.array(NonEmptyStringSchema.max(200)).optional().meta({
-    title: "Special Circumstances",
-    description: "Any special circumstances affecting the distribution",
-    examples: [
-      "Country-specific threshold applied: Brazil Tax Authority Group I Large Business classification"
-    ]
-  })
-}).meta({
-  title: "Distribution Notes",
-  description: "Additional notes about the reward distribution, discounts, and special circumstances"
-});
-var ParticipantRewardsSchema = zod.z.strictObject({
-  distribution_basis: NonEmptyStringSchema.max(200).meta({
-    title: "Distribution Basis",
-    description: "Basis for the rewards distribution"
-  }),
-  reward_allocations: zod.z.array(RewardAllocationSchema).min(1).meta({
-    title: "Reward Allocations",
-    description: "Rewards percentage allocated to each participant"
-  }),
-  distribution_notes: DistributionNotesSchema.optional().meta({
-    title: "Distribution Notes",
-    description: "Additional notes about the reward distribution"
-  })
-}).meta({
-  title: "Participant Rewards",
-  description: "Rewards distribution to participants"
-});
 var SummaryBaseSchema = zod.z.strictObject({
   total_certificates: PositiveIntegerSchema.meta({
     title: "Total Certificates",
@@ -29647,7 +29554,7 @@ function buildSchemaUrl(schemaPath) {
   return `${getSchemaBaseUrl()}/${cleanPath}`;
 }
 function getSchemaVersionOrDefault() {
-  return "0.1.61";
+  return "0.1.62";
 }
 
 // src/shared/schema-validation.ts
@@ -30073,6 +29980,7 @@ var MassIDAttributeWeightSchema = createWeightAttributeSchema({
   description: "Net batch weight in kilograms (kg) for this MassID"
 });
 var MassIDAttributeOriginCitySchema = OriginCityAttributeSchema;
+var MassIDAttributeOriginCountrySubdivisionSchema = OriginCountrySubdivisionAttributeSchema;
 var MassIDAttributePickUpVehicleTypeSchema = NftAttributeSchema.safeExtend({
   trait_type: zod.z.literal("Pick-up Vehicle Type"),
   value: VehicleTypeSchema.meta({
@@ -30157,6 +30065,7 @@ var REQUIRED_MASS_ID_ATTRIBUTES = [
   MassIDAttributeWasteSubtypeSchema,
   MassIDAttributeWeightSchema,
   MassIDAttributeOriginCitySchema,
+  MassIDAttributeOriginCountrySubdivisionSchema,
   MassIDAttributePickUpVehicleTypeSchema,
   MassIDAttributeRecyclingMethodSchema,
   MassIDAttributePickUpDateSchema,
@@ -30181,6 +30090,7 @@ var MassIDAttributesSchema = createOrderedAttributesSchema({
     "Waste Subtype",
     "Weight (kg)",
     "Origin City",
+    "Origin Country Subdivision",
     "Pick-up Vehicle Type",
     "Recycling Method",
     "Pick-up Date",
@@ -30216,7 +30126,7 @@ var MassIDWastePropertiesSchema = zod.z.strictObject({
     description: "Specific subcategory of waste material"
   }),
   local_classification: MassIDLocalClassificationSchema.optional(),
-  net_weight_kg: WeightKgSchema.meta({
+  weight_kg: WeightKgSchema.meta({
     title: "Net Weight",
     description: "Net weight of the waste batch in kilograms (kg)",
     examples: [3e3]
@@ -30499,9 +30409,9 @@ var MassIDIpfsSchema = NftIpfsSchema.safeExtend({
     ctx,
     attributeByTraitType,
     traitType: "Weight (kg)",
-    expectedValue: data.waste_properties.net_weight_kg,
-    missingMessage: "Weight (kg) attribute must be present and match waste_properties.net_weight_kg",
-    mismatchMessage: "Weight (kg) attribute must equal waste_properties.net_weight_kg"
+    expectedValue: data.waste_properties.weight_kg,
+    missingMessage: "Weight (kg) attribute must be present and match waste_properties.weight_kg",
+    mismatchMessage: "Weight (kg) attribute must equal waste_properties.weight_kg"
   });
   validateAttributeValue({
     ctx,
@@ -30619,6 +30529,7 @@ var GasIDAttributeCreditTypeSchema = CreditTypeAttributeSchema;
 var GasIDAttributeSourceWasteTypeSchema = SourceWasteTypeAttributeSchema;
 var GasIDAttributeSourceWeightSchema = SourceWeightAttributeSchema;
 var GasIDAttributeOriginCitySchema = OriginCityAttributeSchema;
+var GasIDAttributeOriginCountrySubdivisionSchema = OriginCountrySubdivisionAttributeSchema;
 var GasIDAttributeMassIDTokenIdSchema = MassIDTokenIdAttributeSchema;
 var GasIDAttributeMassIDRecyclingDateSchema = MassIDRecyclingDateAttributeSchema;
 var GasIDAttributeCertificateIssuanceDateSchema = CertificateIssuanceDateAttributeSchema;
@@ -30631,12 +30542,13 @@ var GasIDAttributesSchema = zod.z.tuple([
   GasIDAttributeSourceWasteTypeSchema,
   GasIDAttributeSourceWeightSchema,
   GasIDAttributeOriginCitySchema,
+  GasIDAttributeOriginCountrySubdivisionSchema,
   GasIDAttributeMassIDTokenIdSchema,
   GasIDAttributeMassIDRecyclingDateSchema,
   GasIDAttributeCertificateIssuanceDateSchema
 ]).meta({
   title: "GasID NFT Attribute Array",
-  description: "Schema for the fixed set of GasID NFT attributes, enforcing order and type for each trait.\n\nRequired attributes (11, in order): Methodology, Gas Type, CO\u2082e Prevented (kg), Credit Amount, Credit Type, Source Waste Type, Source Weight (kg), Origin City, MassID, MassID Recycling Date, Certificate Issuance Date."
+  description: "Schema for the fixed set of GasID NFT attributes, enforcing order and type for each trait.\n\nRequired attributes (12, in order): Methodology, Gas Type, CO\u2082e Prevented (kg), Credit Amount, Credit Type, Source Waste Type, Source Weight (kg), Origin City, Origin Country Subdivision, MassID, MassID Recycling Date, Certificate Issuance Date."
 });
 var GasIDSummarySchema = zod.z.strictObject({
   gas_type: GasTypeSchema,
@@ -30711,8 +30623,7 @@ var GasIDDataSchema = zod.z.strictObject({
     title: "Source Waste Origin Location",
     description: "Location of the waste origin"
   }),
-  prevented_emissions_calculation: PreventedEmissionsCalculationSchema,
-  participant_rewards: ParticipantRewardsSchema
+  prevented_emissions_calculation: PreventedEmissionsCalculationSchema
 }).meta({
   title: "GasID Data",
   description: "Complete data structure for GasID certificate"
@@ -30821,9 +30732,9 @@ var GasIDIpfsSchema = NftIpfsSchema.safeExtend({
     ctx,
     attributeByTraitType,
     traitType: "Source Weight (kg)",
-    expectedValue: data.waste_properties.net_weight_kg,
-    missingMessage: "Source Weight (kg) attribute must be present and match data.waste_properties.net_weight_kg",
-    mismatchMessage: "Source Weight (kg) attribute must equal data.waste_properties.net_weight_kg"
+    expectedValue: data.waste_properties.weight_kg,
+    missingMessage: "Source Weight (kg) attribute must be present and match data.waste_properties.weight_kg",
+    mismatchMessage: "Source Weight (kg) attribute must equal data.waste_properties.weight_kg"
   });
   validateAttributeValue({
     ctx,
@@ -30879,8 +30790,8 @@ var GasIDIpfsSchema = NftIpfsSchema.safeExtend({
 var RecycledIDAttributeMethodologySchema = MethodologyAttributeSchema;
 var RecycledIDAttributeRecycledMassWeightSchema = createWeightAttributeSchema(
   {
-    traitType: "Recycled Mass Weight (kg)",
-    title: "Recycled Mass Weight",
+    traitType: "Recycled Weight (kg)",
+    title: "Recycled Weight",
     description: "Total weight of recycled materials in kilograms"
   }
 );
@@ -30889,6 +30800,7 @@ var RecycledIDAttributeCreditTypeSchema = CreditTypeAttributeSchema;
 var RecycledIDAttributeSourceWasteTypeSchema = SourceWasteTypeAttributeSchema;
 var RecycledIDAttributeSourceWeightSchema = SourceWeightAttributeSchema;
 var RecycledIDAttributeOriginCitySchema = OriginCityAttributeSchema;
+var RecycledIDAttributeOriginCountrySubdivisionSchema = OriginCountrySubdivisionAttributeSchema;
 var RecycledIDAttributeMassIDTokenIdSchema = MassIDTokenIdAttributeSchema;
 var RecycledIDAttributeMassIDRecyclingDateSchema = MassIDRecyclingDateAttributeSchema;
 var RecycledIDAttributeCertificateIssuanceDateSchema = CertificateIssuanceDateAttributeSchema;
@@ -30900,16 +30812,17 @@ var RecycledIDAttributesSchema = zod.z.tuple([
   RecycledIDAttributeSourceWasteTypeSchema,
   RecycledIDAttributeSourceWeightSchema,
   RecycledIDAttributeOriginCitySchema,
+  RecycledIDAttributeOriginCountrySubdivisionSchema,
   RecycledIDAttributeMassIDTokenIdSchema,
   RecycledIDAttributeMassIDRecyclingDateSchema,
   RecycledIDAttributeCertificateIssuanceDateSchema
 ]).meta({
   title: "RecycledID NFT Attribute Array",
-  description: "Schema for the fixed set of RecycledID NFT attributes, enforcing order and type for each trait.\n\nRequired attributes (10, in order): Methodology, Recycled Mass Weight (kg), Credit Amount, Credit Type, Source Waste Type, Source Weight (kg), Origin City, MassID, MassID Recycling Date, Certificate Issuance Date."
+  description: "Schema for the fixed set of RecycledID NFT attributes, enforcing order and type for each trait.\n\nRequired attributes (11, in order): Methodology, Recycled Weight (kg), Credit Amount, Credit Type, Source Waste Type, Source Weight (kg), Origin City, Origin Country Subdivision, MassID, MassID Recycling Date, Certificate Issuance Date."
 });
 var RecycledIDSummarySchema = zod.z.strictObject({
   recycled_mass_kg: WeightKgSchema.meta({
-    title: "Recycled Mass Weight",
+    title: "Recycled Weight",
     description: "Total weight of materials successfully recycled in kilograms (kg)"
   }),
   credit_type: CreditTypeSchema,
@@ -30931,8 +30844,7 @@ var RecycledIDDataSchema = zod.z.strictObject({
   origin_location: LocationSchema.meta({
     title: "RecycledID Origin Location",
     description: "Source waste origin location details"
-  }),
-  participant_rewards: ParticipantRewardsSchema
+  })
 }).meta({
   title: "RecycledID Data",
   description: "Complete data structure for RecycledID certificate"
@@ -30999,11 +30911,11 @@ var RecycledIDIpfsSchema = NftIpfsSchema.safeExtend({
   validateNumericAttributeValue({
     ctx,
     attributeByTraitType,
-    traitType: "Recycled Mass Weight (kg)",
+    traitType: "Recycled Weight (kg)",
     expectedValue: data.summary.recycled_mass_kg,
     epsilon: 0.01,
-    missingMessage: "Recycled Mass Weight (kg) attribute must be present and match data.summary.recycled_mass_kg",
-    mismatchMessage: "Recycled Mass Weight (kg) attribute must equal data.summary.recycled_mass_kg"
+    missingMessage: "Recycled Weight (kg) attribute must be present and match data.summary.recycled_mass_kg",
+    mismatchMessage: "Recycled Weight (kg) attribute must equal data.summary.recycled_mass_kg"
   });
   validateAttributeValue({
     ctx,
@@ -31033,9 +30945,9 @@ var RecycledIDIpfsSchema = NftIpfsSchema.safeExtend({
     ctx,
     attributeByTraitType,
     traitType: "Source Weight (kg)",
-    expectedValue: data.waste_properties.net_weight_kg,
-    missingMessage: "Source Weight (kg) attribute must be present and match data.waste_properties.net_weight_kg",
-    mismatchMessage: "Source Weight (kg) attribute must equal data.waste_properties.net_weight_kg"
+    expectedValue: data.waste_properties.weight_kg,
+    missingMessage: "Source Weight (kg) attribute must be present and match data.waste_properties.weight_kg",
+    mismatchMessage: "Source Weight (kg) attribute must equal data.waste_properties.weight_kg"
   });
   validateAttributeValue({
     ctx,
@@ -31206,23 +31118,6 @@ var CreditPurchaseReceiptCertificateSchema = CertificateReferenceBaseSchema.safe
   title: "Certificate",
   description: "Certificate associated with the purchase"
 });
-var CreditPurchaseReceiptParticipantRewardSchema = zod.z.strictObject({
-  participant_id_hash: ParticipantIdHashSchema,
-  roles: uniqueArrayItems(
-    ParticipantRoleSchema,
-    "Participant roles must be unique"
-  ).min(1).meta({
-    title: "Participant Roles",
-    description: "Roles the participant has in the supply chain"
-  }),
-  usdc_amount: UsdcAmountSchema.meta({
-    title: "USDC Reward Amount",
-    description: "USDC amount allocated to this participant"
-  })
-}).meta({
-  title: "Participant Reward",
-  description: "Reward distribution for a participant"
-});
 var CreditPurchaseReceiptRetirementReceiptSchema = CreditRetirementReceiptReferenceSchema;
 var CreditPurchaseReceiptDataSchema = zod.z.strictObject({
   summary: CreditPurchaseReceiptSummarySchema,
@@ -31251,14 +31146,6 @@ var CreditPurchaseReceiptDataSchema = zod.z.strictObject({
     title: "Certificates",
     description: "Certificates involved in the purchase"
   }),
-  participant_rewards: uniqueBy(
-    CreditPurchaseReceiptParticipantRewardSchema,
-    (reward) => reward.participant_id_hash,
-    "Participant participant_id_hash must be unique"
-  ).min(1).meta({
-    title: "Participant Rewards",
-    description: "Rewards distributed to participants in the supply chain for this purchase"
-  }),
   retirement_receipt: CreditPurchaseReceiptRetirementReceiptSchema.optional()
 }).superRefine((data, ctx) => {
   validateCountMatches({
@@ -31351,17 +31238,6 @@ var CreditPurchaseReceiptDataSchema = zod.z.strictObject({
     hasRetirementReceipt: !!data.retirement_receipt,
     totalRetiredAmount: certificateCollectionRetiredTotal
   });
-  const participantRewardTotal = data.participant_rewards.reduce(
-    (sum, reward) => sum + Number(reward.usdc_amount),
-    0
-  );
-  validateTotalMatches({
-    ctx,
-    actualTotal: participantRewardTotal,
-    expectedTotal: data.summary.total_amount_usdc,
-    path: ["summary", "total_amount_usdc"],
-    message: "summary.total_amount_usdc must equal sum of participant_rewards.usdc_amount"
-  });
 }).meta({
   title: "Credit Purchase Receipt Data",
   description: "Complete data structure for a credit purchase receipt"
@@ -32260,7 +32136,6 @@ exports.CreditTokenSlugSchema = CreditTokenSlugSchema;
 exports.CreditTokenSymbolSchema = CreditTokenSymbolSchema;
 exports.CreditTypeAttributeSchema = CreditTypeAttributeSchema;
 exports.CreditTypeSchema = CreditTypeSchema;
-exports.DistributionNotesSchema = DistributionNotesSchema;
 exports.EPSILON = EPSILON;
 exports.EnsDomainSchema = EnsDomainSchema;
 exports.EthereumAddressSchema = EthereumAddressSchema;
@@ -32314,8 +32189,8 @@ exports.NonEmptyStringSchema = NonEmptyStringSchema;
 exports.NonNegativeFloatSchema = NonNegativeFloatSchema;
 exports.NonNegativeIntegerSchema = NonNegativeIntegerSchema;
 exports.OriginCityAttributeSchema = OriginCityAttributeSchema;
+exports.OriginCountrySubdivisionAttributeSchema = OriginCountrySubdivisionAttributeSchema;
 exports.ParticipantIdHashSchema = ParticipantIdHashSchema;
-exports.ParticipantRewardsSchema = ParticipantRewardsSchema;
 exports.ParticipantRoleSchema = ParticipantRoleSchema;
 exports.ParticipantSchema = ParticipantSchema;
 exports.PercentageSchema = PercentageSchema;
@@ -32330,9 +32205,6 @@ exports.RecycledIDIpfsSchemaMeta = RecycledIDIpfsSchemaMeta;
 exports.RecycledIDNameSchema = RecycledIDNameSchema;
 exports.RecycledIDReferenceSchema = RecycledIDReferenceSchema;
 exports.RecycledIDShortNameSchema = RecycledIDShortNameSchema;
-exports.RewardAllocationSchema = RewardAllocationSchema;
-exports.RewardDiscountSchema = RewardDiscountSchema;
-exports.RewardDiscountTypeSchema = RewardDiscountTypeSchema;
 exports.ScaleTypeSchema = ScaleTypeSchema;
 exports.SchemaInfoSchema = SchemaInfoSchema;
 exports.SemanticVersionSchema = SemanticVersionSchema;