@takodotid/circuit 0.10.0 → 0.11.0

package/dist/presets/index.js

@@ -179,8 +179,8 @@ function communityScheme(scheme) {
       action: "accept"
     };
   };
-  const actions = (neighborAs) => [
-    ...scheme.blackhole !== undefined ? [
+  const actions = (neighborAs, options = {}) => [
+    ...scheme.blackhole !== undefined && !options.blackhole ? [
       {
         description: "Blackholed here, never announced",
         match: { large_community: community(scheme.blackhole, 0) },
@@ -199,6 +199,18 @@ function communityScheme(scheme) {
         action: "reject"
       }
     ] : [],
+    ...scheme.blackhole !== undefined && options.blackhole ? [
+      {
+        description: `Blackhole passed on to AS${neighborAs}`,
+        match: { large_community: community(scheme.blackhole, 0) },
+        set: {
+          remove_communities: ours.standard,
+          remove_large_communities: ours.large,
+          add_communities: [options.blackhole]
+        },
+        action: "accept"
+      }
+    ] : [],
     ...PREPENDS.flatMap(([name, times]) => {
       const fn = scheme.prepend?.[name];
       if (fn === undefined)

package/dist/types/presets/index.d.ts

@@ -83,7 +83,7 @@ export type CommunityScheme<Class extends string = string> = {
  * Policy rules and a catalogue from one community scheme, so the communities your routers set, the ones they act on, and the ones you publish never disagree.
  *
  * - `tag(neighborClass, neighborAs, { site, keepActions })`: a rule for an import policy. It removes your communities a neighbor set, then adds where the route was learned. `site` is needed when the scheme has `learned_at`. With `keepActions`, for a customer, its action communities stay.
- * - `actions(neighborAs)`: rules for an export policy toward one neighbor. They act on a customer's action communities, then remove all of yours. Place them before the rules that accept.
+ * - `actions(neighborAs, { blackhole })`: rules for an export policy toward one neighbor. They act on a customer's action communities, then remove all of yours. Place them before the rules that accept. A blackholed route goes no further, unless `blackhole` names the neighbor's own blackhole community: then it is passed on with it, so the neighbor drops the traffic too.
  * - `blackhole(prefixSet)`: a rule for a customer's import policy, before anything that rejects long prefixes. It takes a route the customer asked to blackhole, but only inside `prefixSet`, its own space, and drops traffic to it here.
  * - `catalogue`: every community, for `communities` in `defineNetwork`.
  */
@@ -93,7 +93,9 @@ export declare function communityScheme<const Class extends string>(scheme: Comm
         site?: number;
         keepActions?: boolean;
     }) => PolicyRule<never, never>;
-    actions: (neighborAs: number) => PolicyRule<never, never>[];
+    actions: (neighborAs: number, options?: {
+        blackhole?: string;
+    }) => PolicyRule<never, never>[];
     blackhole: <S extends string>(prefixSet: S) => PolicyRule<never, S>;
     catalogue: Community[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@takodotid/circuit",
-    "version": "0.10.0",
+    "version": "0.11.0",
     "description": "Declarative, vendor-neutral network configuration: describe each device in TypeScript, and Circuit makes the device match. Alpha.",
     "keywords": [
         "network",

package/src/presets/index.ts

@@ -239,7 +239,7 @@ const article = (word: string) => (/^[aeiou]/i.test(word) ? `an ${word}` : `a ${
  * Policy rules and a catalogue from one community scheme, so the communities your routers set, the ones they act on, and the ones you publish never disagree.
  *
  * - `tag(neighborClass, neighborAs, { site, keepActions })`: a rule for an import policy. It removes your communities a neighbor set, then adds where the route was learned. `site` is needed when the scheme has `learned_at`. With `keepActions`, for a customer, its action communities stay.
- * - `actions(neighborAs)`: rules for an export policy toward one neighbor. They act on a customer's action communities, then remove all of yours. Place them before the rules that accept.
+ * - `actions(neighborAs, { blackhole })`: rules for an export policy toward one neighbor. They act on a customer's action communities, then remove all of yours. Place them before the rules that accept. A blackholed route goes no further, unless `blackhole` names the neighbor's own blackhole community: then it is passed on with it, so the neighbor drops the traffic too.
  * - `blackhole(prefixSet)`: a rule for a customer's import policy, before anything that rejects long prefixes. It takes a route the customer asked to blackhole, but only inside `prefixSet`, its own space, and drops traffic to it here.
  * - `catalogue`: every community, for `communities` in `defineNetwork`.
  */
@@ -286,8 +286,8 @@ export function communityScheme<const Class extends string>(scheme: CommunitySch
         };
     };
 
-    const actions = (neighborAs: number): PolicyRule<never, never>[] => [
-        ...(scheme.blackhole !== undefined
+    const actions = (neighborAs: number, options: { blackhole?: string } = {}): PolicyRule<never, never>[] => [
+        ...(scheme.blackhole !== undefined && !options.blackhole
             ? [
                   {
                       description: "Blackholed here, never announced",
@@ -310,6 +310,20 @@ export function communityScheme<const Class extends string>(scheme: CommunitySch
                   },
               ]
             : []),
+        ...(scheme.blackhole !== undefined && options.blackhole
+            ? [
+                  {
+                      description: `Blackhole passed on to AS${neighborAs}`,
+                      match: { large_community: community(scheme.blackhole, 0) },
+                      set: {
+                          remove_communities: ours.standard,
+                          remove_large_communities: ours.large,
+                          add_communities: [options.blackhole],
+                      },
+                      action: "accept" as const,
+                  },
+              ]
+            : []),
         ...PREPENDS.flatMap(([name, times]) => {
             const fn = scheme.prepend?.[name];
             if (fn === undefined) return [];