diff --git a/src/pages/sdk/agent-core/README.mdx b/src/pages/sdk/agent-core/README.mdx index 2dbb389..3ce376a 100644 --- a/src/pages/sdk/agent-core/README.mdx +++ b/src/pages/sdk/agent-core/README.mdx @@ -25,6 +25,12 @@ export const metadata = { - [DelegationCanonicalInput](interfaces/DelegationCanonicalInput.mdx) - [DelegationEnvelope](interfaces/DelegationEnvelope.mdx) - [DelegationRevocationRef](interfaces/DelegationRevocationRef.mdx) +- [FederationDelegationEnvelope](interfaces/FederationDelegationEnvelope.mdx) +- [FederationDescriptor](interfaces/FederationDescriptor.mdx) +- [FederationGuardian](interfaces/FederationGuardian.mdx) +- [FederationPrincipal](interfaces/FederationPrincipal.mdx) +- [FederationRevocationEnvelope](interfaces/FederationRevocationEnvelope.mdx) +- [FederationSignature](interfaces/FederationSignature.mdx) - [RevocationCanonicalInput](interfaces/RevocationCanonicalInput.mdx) - [RevocationEnvelope](interfaces/RevocationEnvelope.mdx) - [Scope](interfaces/Scope.mdx) @@ -42,6 +48,9 @@ export const metadata = { - [VerifyBase](interfaces/VerifyBase.mdx) - [VerifyDelegationInput](interfaces/VerifyDelegationInput.mdx) - [VerifyErr](interfaces/VerifyErr.mdx) +- [VerifyFederationBase](interfaces/VerifyFederationBase.mdx) +- [VerifyFederationDelegationInput](interfaces/VerifyFederationDelegationInput.mdx) +- [VerifyFederationRevocationInput](interfaces/VerifyFederationRevocationInput.mdx) - [VerifyOk](interfaces/VerifyOk.mdx) - [VerifyRevocationInput](interfaces/VerifyRevocationInput.mdx) - [VerifySubdelegationInput](interfaces/VerifySubdelegationInput.mdx) @@ -51,6 +60,7 @@ export const metadata = { - [AgentErrorCode](type-aliases/AgentErrorCode.mdx) - [ChainLink](type-aliases/ChainLink.mdx) - [EnvelopeKind](type-aliases/EnvelopeKind.mdx) +- [FederationVerifyResult](type-aliases/FederationVerifyResult.mdx) - [RevocationHolder](type-aliases/RevocationHolder.mdx) - [ScopeOp](type-aliases/ScopeOp.mdx) - [VerifyActionResult](type-aliases/VerifyActionResult.mdx) @@ -60,6 +70,7 @@ export const metadata = { ## Variables +- [canonicalize](variables/canonicalize.mdx) - [DEFAULT\_MAX\_CHAIN\_DEPTH](variables/DEFAULT_MAX_CHAIN_DEPTH.mdx) - [ENVELOPE\_VERSION](variables/ENVELOPE_VERSION.mdx) - [REGISTERED\_SCOPES](variables/REGISTERED_SCOPES.mdx) @@ -70,7 +81,6 @@ export const metadata = { - [actionCanonicalMessage](functions/actionCanonicalMessage.mdx) - [canonicalActionBytes](functions/canonicalActionBytes.mdx) - [canonicalDelegationBytes](functions/canonicalDelegationBytes.mdx) -- [canonicalize](functions/canonicalize.mdx) - [canonicalizeAction](functions/canonicalizeAction.mdx) - [canonicalizeDelegation](functions/canonicalizeDelegation.mdx) - [canonicalizeRevocation](functions/canonicalizeRevocation.mdx) @@ -80,14 +90,15 @@ export const metadata = { - [canonicalRevocationBytes](functions/canonicalRevocationBytes.mdx) - [computeActionId](functions/computeActionId.mdx) - [computeDelegationId](functions/computeDelegationId.mdx) +- [computeFederationDescriptorId](functions/computeFederationDescriptorId.mdx) - [computeRevocationId](functions/computeRevocationId.mdx) - [computeSubdelegationId](functions/computeSubdelegationId.mdx) - [decodeScopesPayload](functions/decodeScopesPayload.mdx) - [delegationCanonicalBytes](functions/delegationCanonicalBytes.mdx) - [delegationCanonicalMessage](functions/delegationCanonicalMessage.mdx) - [encodeScopesPayload](functions/encodeScopesPayload.mdx) +- [federationDescriptorCanonicalMessage](functions/federationDescriptorCanonicalMessage.mdx) - [hasPrivateScopes](functions/hasPrivateScopes.mdx) -- [hexEncode](functions/hexEncode.mdx) - [isSubScope](functions/isSubScope.mdx) - [parseAndCanonicalizeScopes](functions/parseAndCanonicalizeScopes.mdx) - [parseScope](functions/parseScope.mdx) @@ -101,5 +112,13 @@ export const metadata = { - [validateScope](functions/validateScope.mdx) - [verifyAction](functions/verifyAction.mdx) - [verifyDelegation](functions/verifyDelegation.mdx) +- [verifyFederationDelegation](functions/verifyFederationDelegation.mdx) +- [verifyFederationRevocation](functions/verifyFederationRevocation.mdx) - [verifyRevocation](functions/verifyRevocation.mdx) - [verifySubdelegation](functions/verifySubdelegation.mdx) + +## References + +### hexEncode + +Renames and re-exports [canonicalize](variables/canonicalize.mdx) diff --git a/src/pages/sdk/agent-core/classes/AgentError.mdx b/src/pages/sdk/agent-core/classes/AgentError.mdx index 848abc2..89a9cfa 100644 --- a/src/pages/sdk/agent-core/classes/AgentError.mdx +++ b/src/pages/sdk/agent-core/classes/AgentError.mdx @@ -46,112 +46,9 @@ Error.constructor ## Properties -| Property | Modifier | Type | Description | Inherited from | Defined in | -| ------ | ------ | ------ | ------ | ------ | ------ | -| <a id="property-code"></a> `code` | `public` | [`AgentErrorCode`](../type-aliases/AgentErrorCode.mdx) | - | - | [agent-core/src/verify.ts:54](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/verify.ts#L54) | -| <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 | -| <a id="property-name"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 | -| <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | agent-core/node\_modules/@types/node/globals.d.ts:68 | - -## Methods - -### captureStackTrace() - -```ts -static captureStackTrace(targetObject: object, constructorOpt?: Function): void; -``` - -Defined in: agent-core/node\_modules/@types/node/globals.d.ts:52 - -Creates a `.stack` property on `targetObject`, which when accessed returns -a string representing the location in the code at which -`Error.captureStackTrace()` was called. - -```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` -``` - -The first line of the trace will be prefixed with -`${myObject.name}: ${myObject.message}`. - -The optional `constructorOpt` argument accepts a function. If given, all frames -above `constructorOpt`, including `constructorOpt`, will be omitted from the -generated stack trace. - -The `constructorOpt` argument is useful for hiding implementation -details of error generation from the user. For instance: - -```js -function a() { - b(); -} - -function b() { - c(); -} - -function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; -} - -a(); -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -```ts -Error.captureStackTrace -``` - -*** - -### prepareStackTrace() - -```ts -static prepareStackTrace(err: Error, stackTraces: CallSite[]): any; -``` - -Defined in: agent-core/node\_modules/@types/node/globals.d.ts:56 - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -```ts -Error.prepareStackTrace -``` +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-code"></a> `code` | [`AgentErrorCode`](../type-aliases/AgentErrorCode.mdx) | - | [agent-core/src/verify.ts:54](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/verify.ts#L54) | +| <a id="property-message"></a> `message` | `string` | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| <a id="property-name"></a> `name` | `string` | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| <a id="property-stack"></a> `stack?` | `string` | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 | diff --git a/src/pages/sdk/agent-core/classes/ScopeParseError.mdx b/src/pages/sdk/agent-core/classes/ScopeParseError.mdx index a885791..f52cb3c 100644 --- a/src/pages/sdk/agent-core/classes/ScopeParseError.mdx +++ b/src/pages/sdk/agent-core/classes/ScopeParseError.mdx @@ -45,111 +45,8 @@ Error.constructor ## Properties -| Property | Modifier | Type | Description | Inherited from | Defined in | -| ------ | ------ | ------ | ------ | ------ | ------ | -| <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 | -| <a id="property-name"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 | -| <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 | -| <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | agent-core/node\_modules/@types/node/globals.d.ts:68 | - -## Methods - -### captureStackTrace() - -```ts -static captureStackTrace(targetObject: object, constructorOpt?: Function): void; -``` - -Defined in: agent-core/node\_modules/@types/node/globals.d.ts:52 - -Creates a `.stack` property on `targetObject`, which when accessed returns -a string representing the location in the code at which -`Error.captureStackTrace()` was called. - -```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` -``` - -The first line of the trace will be prefixed with -`${myObject.name}: ${myObject.message}`. - -The optional `constructorOpt` argument accepts a function. If given, all frames -above `constructorOpt`, including `constructorOpt`, will be omitted from the -generated stack trace. - -The `constructorOpt` argument is useful for hiding implementation -details of error generation from the user. For instance: - -```js -function a() { - b(); -} - -function b() { - c(); -} - -function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; -} - -a(); -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -```ts -Error.captureStackTrace -``` - -*** - -### prepareStackTrace() - -```ts -static prepareStackTrace(err: Error, stackTraces: CallSite[]): any; -``` - -Defined in: agent-core/node\_modules/@types/node/globals.d.ts:56 - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -```ts -Error.prepareStackTrace -``` +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-message"></a> `message` | `string` | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 | +| <a id="property-name"></a> `name` | `string` | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 | +| <a id="property-stack"></a> `stack?` | `string` | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 | diff --git a/src/pages/sdk/agent-core/functions/canonicalize.mdx b/src/pages/sdk/agent-core/functions/canonicalize.mdx deleted file mode 100644 index 7933133..0000000 --- a/src/pages/sdk/agent-core/functions/canonicalize.mdx +++ /dev/null @@ -1,28 +0,0 @@ -export const metadata = { - title: "Function: canonicalize()", - description: "Auto-generated API reference for Function: canonicalize(). Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-core**](../README.mdx) - -*** - -[@orangecheck/agent-core](../README.mdx) / canonicalize - -# Function: canonicalize() - -```ts -function canonicalize(value: JsonValue): string; -``` - -Defined in: agent-core/node\_modules/@orangecheck/stamp-core/dist/canonical.d.ts:17 - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `value` | `JsonValue` | - -## Returns - -`string` diff --git a/src/pages/sdk/agent-core/functions/computeFederationDescriptorId.mdx b/src/pages/sdk/agent-core/functions/computeFederationDescriptorId.mdx new file mode 100644 index 0000000..c0402c3 --- /dev/null +++ b/src/pages/sdk/agent-core/functions/computeFederationDescriptorId.mdx @@ -0,0 +1,30 @@ +export const metadata = { + title: "Function: computeFederationDescriptorId()", + description: "Auto-generated API reference for Function: computeFederationDescriptorId(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / computeFederationDescriptorId + +# Function: computeFederationDescriptorId() + +```ts +function computeFederationDescriptorId(descriptor: FederationDescriptor): string; +``` + +Defined in: [agent-core/src/federation.ts:121](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L121) + +descriptor_id := H(canonical_descriptor_bytes). 64 lowercase hex. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `descriptor` | [`FederationDescriptor`](../interfaces/FederationDescriptor.mdx) | + +## Returns + +`string` diff --git a/src/pages/sdk/agent-core/functions/federationDescriptorCanonicalMessage.mdx b/src/pages/sdk/agent-core/functions/federationDescriptorCanonicalMessage.mdx new file mode 100644 index 0000000..99c6447 --- /dev/null +++ b/src/pages/sdk/agent-core/functions/federationDescriptorCanonicalMessage.mdx @@ -0,0 +1,32 @@ +export const metadata = { + title: "Function: federationDescriptorCanonicalMessage()", + description: "Auto-generated API reference for Function: federationDescriptorCanonicalMessage(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / federationDescriptorCanonicalMessage + +# Function: federationDescriptorCanonicalMessage() + +```ts +function federationDescriptorCanonicalMessage(descriptor: FederationDescriptor): string; +``` + +Defined in: [agent-core/src/federation.ts:109](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L109) + +The canonical, line-oriented descriptor message. Guardians are emitted in +lexicographic byte order of their address (NOT the JSON array order); the +`name` label is excluded — it is JSON-only metadata. No trailing LF. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `descriptor` | [`FederationDescriptor`](../interfaces/FederationDescriptor.mdx) | + +## Returns + +`string` diff --git a/src/pages/sdk/agent-core/functions/hexEncode.mdx b/src/pages/sdk/agent-core/functions/hexEncode.mdx deleted file mode 100644 index 14c2149..0000000 --- a/src/pages/sdk/agent-core/functions/hexEncode.mdx +++ /dev/null @@ -1,28 +0,0 @@ -export const metadata = { - title: "Function: hexEncode()", - description: "Auto-generated API reference for Function: hexEncode(). Source: TypeScript types in oc-packages.", -}; - -[**@orangecheck/agent-core**](../README.mdx) - -*** - -[@orangecheck/agent-core](../README.mdx) / hexEncode - -# Function: hexEncode() - -```ts -function hexEncode(bytes: Uint8Array): string; -``` - -Defined in: agent-core/node\_modules/@orangecheck/stamp-core/dist/canonical.d.ts:18 - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `bytes` | `Uint8Array` | - -## Returns - -`string` diff --git a/src/pages/sdk/agent-core/functions/verifyFederationDelegation.mdx b/src/pages/sdk/agent-core/functions/verifyFederationDelegation.mdx new file mode 100644 index 0000000..3f869bb --- /dev/null +++ b/src/pages/sdk/agent-core/functions/verifyFederationDelegation.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Function: verifyFederationDelegation()", + description: "Auto-generated API reference for Function: verifyFederationDelegation(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / verifyFederationDelegation + +# Function: verifyFederationDelegation() + +```ts +function verifyFederationDelegation(input: VerifyFederationDelegationInput): Promise; +``` + +Defined in: [agent-core/src/federation.ts:228](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L228) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `input` | [`VerifyFederationDelegationInput`](../interfaces/VerifyFederationDelegationInput.mdx) | + +## Returns + +`Promise`\<[`FederationVerifyResult`](../type-aliases/FederationVerifyResult.mdx)\> diff --git a/src/pages/sdk/agent-core/functions/verifyFederationRevocation.mdx b/src/pages/sdk/agent-core/functions/verifyFederationRevocation.mdx new file mode 100644 index 0000000..b067b43 --- /dev/null +++ b/src/pages/sdk/agent-core/functions/verifyFederationRevocation.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Function: verifyFederationRevocation()", + description: "Auto-generated API reference for Function: verifyFederationRevocation(). Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / verifyFederationRevocation + +# Function: verifyFederationRevocation() + +```ts +function verifyFederationRevocation(input: VerifyFederationRevocationInput): Promise; +``` + +Defined in: [agent-core/src/federation.ts:296](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L296) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `input` | [`VerifyFederationRevocationInput`](../interfaces/VerifyFederationRevocationInput.mdx) | + +## Returns + +`Promise`\<[`FederationVerifyResult`](../type-aliases/FederationVerifyResult.mdx)\> diff --git a/src/pages/sdk/agent-core/interfaces/FederationDelegationEnvelope.mdx b/src/pages/sdk/agent-core/interfaces/FederationDelegationEnvelope.mdx new file mode 100644 index 0000000..cac1a3b --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/FederationDelegationEnvelope.mdx @@ -0,0 +1,31 @@ +export const metadata = { + title: "Interface: FederationDelegationEnvelope", + description: "Auto-generated API reference for Interface: FederationDelegationEnvelope. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationDelegationEnvelope + +# Interface: FederationDelegationEnvelope + +Defined in: [agent-core/src/federation.ts:62](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L62) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| <a id="property-agent"></a> `agent` | [`ActorRef`](ActorRef.mdx) | [agent-core/src/federation.ts:67](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L67) | +| <a id="property-bond"></a> `bond` | [`DelegationBond`](DelegationBond.mdx) \| `null` | [agent-core/src/federation.ts:69](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L69) | +| <a id="property-expires_at"></a> `expires_at` | `string` | [agent-core/src/federation.ts:71](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L71) | +| <a id="property-id"></a> `id` | `string` | [agent-core/src/federation.ts:65](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L65) | +| <a id="property-issued_at"></a> `issued_at` | `string` | [agent-core/src/federation.ts:70](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L70) | +| <a id="property-kind"></a> `kind` | `"agent-delegation"` | [agent-core/src/federation.ts:64](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L64) | +| <a id="property-nonce"></a> `nonce` | `string` | [agent-core/src/federation.ts:72](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L72) | +| <a id="property-principal"></a> `principal` | [`FederationPrincipal`](FederationPrincipal.mdx) | [agent-core/src/federation.ts:66](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L66) | +| <a id="property-revocation"></a> `revocation` | [`DelegationRevocationRef`](DelegationRevocationRef.mdx) | [agent-core/src/federation.ts:73](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L73) | +| <a id="property-scopes"></a> `scopes` | `string`[] | [agent-core/src/federation.ts:68](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L68) | +| <a id="property-sig"></a> `sig` | [`FederationSignature`](FederationSignature.mdx) | [agent-core/src/federation.ts:74](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L74) | +| <a id="property-v"></a> `v` | `1` | [agent-core/src/federation.ts:63](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L63) | diff --git a/src/pages/sdk/agent-core/interfaces/FederationDescriptor.mdx b/src/pages/sdk/agent-core/interfaces/FederationDescriptor.mdx new file mode 100644 index 0000000..3f29b92 --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/FederationDescriptor.mdx @@ -0,0 +1,23 @@ +export const metadata = { + title: "Interface: FederationDescriptor", + description: "Auto-generated API reference for Interface: FederationDescriptor. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationDescriptor + +# Interface: FederationDescriptor + +Defined in: [agent-core/src/federation.ts:42](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L42) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-guardians"></a> `guardians` | [`FederationGuardian`](FederationGuardian.mdx)[] | - | [agent-core/src/federation.ts:47](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L47) | +| <a id="property-kind"></a> `kind` | `"agent-federation"` | - | [agent-core/src/federation.ts:44](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L44) | +| <a id="property-threshold"></a> `threshold` | `string` | "M-of-N", 1 ≤ M ≤ N, N === guardians.length. | [agent-core/src/federation.ts:46](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L46) | +| <a id="property-v"></a> `v` | `1` | - | [agent-core/src/federation.ts:43](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L43) | diff --git a/src/pages/sdk/agent-core/interfaces/FederationGuardian.mdx b/src/pages/sdk/agent-core/interfaces/FederationGuardian.mdx new file mode 100644 index 0000000..00aa1a0 --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/FederationGuardian.mdx @@ -0,0 +1,22 @@ +export const metadata = { + title: "Interface: FederationGuardian", + description: "Auto-generated API reference for Interface: FederationGuardian. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationGuardian + +# Interface: FederationGuardian + +Defined in: [agent-core/src/federation.ts:34](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L34) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-address"></a> `address` | `string` | mainnet Bitcoin address (P2WPKH, P2TR, or P2PKH). | [agent-core/src/federation.ts:36](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L36) | +| <a id="property-alg"></a> `alg` | `"bip322"` | - | [agent-core/src/federation.ts:37](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L37) | +| <a id="property-name"></a> `name?` | `string` | Optional human label. NOT part of the cryptographic identity. | [agent-core/src/federation.ts:39](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L39) | diff --git a/src/pages/sdk/agent-core/interfaces/FederationPrincipal.mdx b/src/pages/sdk/agent-core/interfaces/FederationPrincipal.mdx new file mode 100644 index 0000000..b472b6b --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/FederationPrincipal.mdx @@ -0,0 +1,22 @@ +export const metadata = { + title: "Interface: FederationPrincipal", + description: "Auto-generated API reference for Interface: FederationPrincipal. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationPrincipal + +# Interface: FederationPrincipal + +Defined in: [agent-core/src/federation.ts:50](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L50) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| <a id="property-alg"></a> `alg` | `"federation"` | [agent-core/src/federation.ts:51](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L51) | +| <a id="property-descriptor"></a> `descriptor` | [`FederationDescriptor`](FederationDescriptor.mdx) | [agent-core/src/federation.ts:53](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L53) | +| <a id="property-descriptor_id"></a> `descriptor_id` | `string` | [agent-core/src/federation.ts:52](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L52) | diff --git a/src/pages/sdk/agent-core/interfaces/FederationRevocationEnvelope.mdx b/src/pages/sdk/agent-core/interfaces/FederationRevocationEnvelope.mdx new file mode 100644 index 0000000..5cf13aa --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/FederationRevocationEnvelope.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Interface: FederationRevocationEnvelope", + description: "Auto-generated API reference for Interface: FederationRevocationEnvelope. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationRevocationEnvelope + +# Interface: FederationRevocationEnvelope + +Defined in: [agent-core/src/federation.ts:77](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L77) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-delegation_id"></a> `delegation_id` | `string` | - | [agent-core/src/federation.ts:81](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L81) | +| <a id="property-id"></a> `id` | `string` | - | [agent-core/src/federation.ts:80](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L80) | +| <a id="property-kind"></a> `kind` | `"agent-revocation"` | - | [agent-core/src/federation.ts:79](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L79) | +| <a id="property-ots"></a> `ots?` | `unknown` | - | [agent-core/src/federation.ts:86](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L86) | +| <a id="property-reason"></a> `reason` | `string` | - | [agent-core/src/federation.ts:84](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L84) | +| <a id="property-sig"></a> `sig` | [`FederationSignature`](FederationSignature.mdx) | - | [agent-core/src/federation.ts:87](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L87) | +| <a id="property-signed_at"></a> `signed_at` | `string` | - | [agent-core/src/federation.ts:85](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L85) | +| <a id="property-signer"></a> `signer` | [`FederationPrincipal`](FederationPrincipal.mdx) | Federation principal that authorizes the revocation (the guardian set). | [agent-core/src/federation.ts:83](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L83) | +| <a id="property-v"></a> `v` | `1` | - | [agent-core/src/federation.ts:78](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L78) | diff --git a/src/pages/sdk/agent-core/interfaces/FederationSignature.mdx b/src/pages/sdk/agent-core/interfaces/FederationSignature.mdx new file mode 100644 index 0000000..44689c0 --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/FederationSignature.mdx @@ -0,0 +1,22 @@ +export const metadata = { + title: "Interface: FederationSignature", + description: "Auto-generated API reference for Interface: FederationSignature. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationSignature + +# Interface: FederationSignature + +Defined in: [agent-core/src/federation.ts:56](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L56) + +## Properties + +| Property | Type | Defined in | +| ------ | ------ | ------ | +| <a id="property-alg"></a> `alg` | `"federation-bip322"` | [agent-core/src/federation.ts:57](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L57) | +| <a id="property-signatures"></a> `signatures` | \{ `guardian_address`: `string`; `value`: `string`; \}[] | [agent-core/src/federation.ts:59](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L59) | +| <a id="property-threshold"></a> `threshold` | `string` | [agent-core/src/federation.ts:58](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L58) | diff --git a/src/pages/sdk/agent-core/interfaces/SealScopesInput.mdx b/src/pages/sdk/agent-core/interfaces/SealScopesInput.mdx index b079416..dc5ece3 100644 --- a/src/pages/sdk/agent-core/interfaces/SealScopesInput.mdx +++ b/src/pages/sdk/agent-core/interfaces/SealScopesInput.mdx @@ -21,7 +21,4 @@ Defined in: [agent-core/src/private-scope.ts:47](https://github.com/orangecheck/ | <a id="property-hint"></a> `hint?` | `string` | Optional human hint stored in the OC Lock envelope. | [agent-core/src/private-scope.ts:54](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L54) | | <a id="property-recipients"></a> `recipients` | `DeviceRecord`[] | Authorized decryptors. Must include at least the agent. | [agent-core/src/private-scope.ts:52](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L52) | | <a id="property-scopes"></a> `scopes` | `string`[] | - | [agent-core/src/private-scope.ts:48](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L48) | -| <a id="property-sender"></a> `sender` | \{ `address`: `string`; `attestation_id?`: `string`; `signMessage`: (`msg`: `string`) => `Promise`\<`string`\>; \} | Principal / sender — the same address that signs the OC Agent envelope. | [agent-core/src/private-scope.ts:50](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L50) | -| `sender.address` | `string` | - | agent-core/node\_modules/@orangecheck/lock-core/dist/types.d.ts:54 | -| `sender.attestation_id?` | `string` | - | agent-core/node\_modules/@orangecheck/lock-core/dist/types.d.ts:55 | -| `sender.signMessage` | (`msg`: `string`) => `Promise`\<`string`\> | - | agent-core/node\_modules/@orangecheck/lock-core/dist/types.d.ts:56 | +| <a id="property-sender"></a> `sender` | `SealInput` | Principal / sender — the same address that signs the OC Agent envelope. | [agent-core/src/private-scope.ts:50](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L50) | diff --git a/src/pages/sdk/agent-core/interfaces/UnsealScopesInput.mdx b/src/pages/sdk/agent-core/interfaces/UnsealScopesInput.mdx index 83cfbb5..b8e5db9 100644 --- a/src/pages/sdk/agent-core/interfaces/UnsealScopesInput.mdx +++ b/src/pages/sdk/agent-core/interfaces/UnsealScopesInput.mdx @@ -17,9 +17,7 @@ Defined in: [agent-core/src/private-scope.ts:78](https://github.com/orangecheck/ | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-device"></a> `device` | \{ `device_id`: `string`; `secretKey`: `Uint8Array`; \} | - | [agent-core/src/private-scope.ts:80](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L80) | -| `device.device_id` | `string` | - | agent-core/node\_modules/@orangecheck/lock-core/dist/types.d.ts:67 | -| `device.secretKey` | `Uint8Array` | - | agent-core/node\_modules/@orangecheck/lock-core/dist/types.d.ts:68 | +| <a id="property-device"></a> `device` | `UnsealInput` | - | [agent-core/src/private-scope.ts:80](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L80) | | <a id="property-envelope"></a> `envelope` | [`ScopesEncryptedEnvelope`](ScopesEncryptedEnvelope.mdx) | - | [agent-core/src/private-scope.ts:79](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L79) | | <a id="property-skipsenderverification"></a> `skipSenderVerification?` | `boolean` | Skip the inner sender-signature check entirely. Default false. | [agent-core/src/private-scope.ts:85](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L85) | -| <a id="property-verifybip322"></a> `verifyBip322?` | (`msg`: `string`, `signatureB64`: `string`, `address`: `string`) => `Promise`\<`boolean`\> | BIP-322 verifier callback. If omitted, the embedded LockEnvelope's signature is NOT checked — useful for inspection or test paths. | [agent-core/src/private-scope.ts:83](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L83) | +| <a id="property-verifybip322"></a> `verifyBip322?` | `any` | BIP-322 verifier callback. If omitted, the embedded LockEnvelope's signature is NOT checked — useful for inspection or test paths. | [agent-core/src/private-scope.ts:83](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/private-scope.ts#L83) | diff --git a/src/pages/sdk/agent-core/interfaces/VerifyActionOkExtra.mdx b/src/pages/sdk/agent-core/interfaces/VerifyActionOkExtra.mdx index feee046..d55e37d 100644 --- a/src/pages/sdk/agent-core/interfaces/VerifyActionOkExtra.mdx +++ b/src/pages/sdk/agent-core/interfaces/VerifyActionOkExtra.mdx @@ -11,13 +11,13 @@ export const metadata = { # Interface: VerifyActionOkExtra -Defined in: [agent-core/src/types.ts:276](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L276) +Defined in: [agent-core/src/types.ts:282](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L282) ## Properties | Property | Type | Description | Defined in | | ------ | ------ | ------ | ------ | -| <a id="property-anchor"></a> `anchor` | \| \{ `status`: `"none"`; \} \| \{ `status`: `"pending"`; \} \| \{ `blockHash`: `string`; `blockHeight`: `number`; `status`: `"confirmed"`; `verified`: `boolean`; \} | - | [agent-core/src/types.ts:286](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L286) | -| <a id="property-chain"></a> `chain` | [`SubdelegationEnvelope`](SubdelegationEnvelope.mdx)[] | The sub-delegation chain `[S_1, …, S_leaf]`. Empty when the action cites the root directly. The action's authority leaf is `chain[chain.length - 1] ?? delegation`. | [agent-core/src/types.ts:284](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L284) | -| <a id="property-delegation"></a> `delegation` | [`DelegationEnvelope`](DelegationEnvelope.mdx) | The ROOT delegation rooting the authority chain. | [agent-core/src/types.ts:278](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L278) | -| <a id="property-scopeexercised"></a> `scopeExercised` | `string` | - | [agent-core/src/types.ts:285](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L285) | +| <a id="property-anchor"></a> `anchor` | \| \{ `status`: `"none"`; \} \| \{ `status`: `"pending"`; \} \| \{ `blockHash`: `string`; `blockHeight`: `number`; `status`: `"confirmed"`; `verified`: `boolean`; \} | - | [agent-core/src/types.ts:292](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L292) | +| <a id="property-chain"></a> `chain` | [`SubdelegationEnvelope`](SubdelegationEnvelope.mdx)[] | The sub-delegation chain `[S_1, …, S_leaf]`. Empty when the action cites the root directly. The action's authority leaf is `chain[chain.length - 1] ?? delegation`. | [agent-core/src/types.ts:290](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L290) | +| <a id="property-delegation"></a> `delegation` | [`DelegationEnvelope`](DelegationEnvelope.mdx) | The ROOT delegation rooting the authority chain. | [agent-core/src/types.ts:284](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L284) | +| <a id="property-scopeexercised"></a> `scopeExercised` | `string` | - | [agent-core/src/types.ts:291](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L291) | diff --git a/src/pages/sdk/agent-core/interfaces/VerifyErr.mdx b/src/pages/sdk/agent-core/interfaces/VerifyErr.mdx index 75f3129..8687d32 100644 --- a/src/pages/sdk/agent-core/interfaces/VerifyErr.mdx +++ b/src/pages/sdk/agent-core/interfaces/VerifyErr.mdx @@ -11,12 +11,12 @@ export const metadata = { # Interface: VerifyErr -Defined in: [agent-core/src/types.ts:266](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L266) +Defined in: [agent-core/src/types.ts:272](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L272) ## Properties | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-code"></a> `code` | [`AgentErrorCode`](../type-aliases/AgentErrorCode.mdx) | [agent-core/src/types.ts:268](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L268) | -| <a id="property-message"></a> `message` | `string` | [agent-core/src/types.ts:269](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L269) | -| <a id="property-ok"></a> `ok` | `false` | [agent-core/src/types.ts:267](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L267) | +| <a id="property-code"></a> `code` | [`AgentErrorCode`](../type-aliases/AgentErrorCode.mdx) | [agent-core/src/types.ts:274](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L274) | +| <a id="property-message"></a> `message` | `string` | [agent-core/src/types.ts:275](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L275) | +| <a id="property-ok"></a> `ok` | `false` | [agent-core/src/types.ts:273](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L273) | diff --git a/src/pages/sdk/agent-core/interfaces/VerifyFederationBase.mdx b/src/pages/sdk/agent-core/interfaces/VerifyFederationBase.mdx new file mode 100644 index 0000000..c0f68c2 --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/VerifyFederationBase.mdx @@ -0,0 +1,26 @@ +export const metadata = { + title: "Interface: VerifyFederationBase", + description: "Auto-generated API reference for Interface: VerifyFederationBase. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / VerifyFederationBase + +# Interface: VerifyFederationBase + +Defined in: [agent-core/src/federation.ts:94](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L94) + +## Extended by + +- [`VerifyFederationDelegationInput`](VerifyFederationDelegationInput.mdx) +- [`VerifyFederationRevocationInput`](VerifyFederationRevocationInput.mdx) + +## Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| <a id="property-skipsignatureverification"></a> `skipSignatureVerification?` | `boolean` | - | [agent-core/src/federation.ts:97](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L97) | +| <a id="property-verifybip322"></a> `verifyBip322?` | (`msg`: `string`, `signatureB64`: `string`, `address`: `string`) => `Promise`\<`boolean`\> | Injected BIP-322 verifier. Required unless `skipSignatureVerification`. | [agent-core/src/federation.ts:96](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L96) | diff --git a/src/pages/sdk/agent-core/interfaces/VerifyFederationDelegationInput.mdx b/src/pages/sdk/agent-core/interfaces/VerifyFederationDelegationInput.mdx new file mode 100644 index 0000000..78db6b7 --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/VerifyFederationDelegationInput.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Interface: VerifyFederationDelegationInput", + description: "Auto-generated API reference for Interface: VerifyFederationDelegationInput. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / VerifyFederationDelegationInput + +# Interface: VerifyFederationDelegationInput + +Defined in: [agent-core/src/federation.ts:222](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L222) + +## Extends + +- [`VerifyFederationBase`](VerifyFederationBase.mdx) + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| <a id="property-envelope"></a> `envelope` | [`FederationDelegationEnvelope`](FederationDelegationEnvelope.mdx) | - | - | [agent-core/src/federation.ts:223](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L223) | +| <a id="property-now"></a> `now?` | `Date` | - | - | [agent-core/src/federation.ts:224](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L224) | +| <a id="property-skipsignatureverification"></a> `skipSignatureVerification?` | `boolean` | - | [`VerifyFederationBase`](VerifyFederationBase.mdx).[`skipSignatureVerification`](VerifyFederationBase.mdx#property-skipsignatureverification) | [agent-core/src/federation.ts:97](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L97) | +| <a id="property-skiptemporalcheck"></a> `skipTemporalCheck?` | `boolean` | - | - | [agent-core/src/federation.ts:225](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L225) | +| <a id="property-verifybip322"></a> `verifyBip322?` | (`msg`: `string`, `signatureB64`: `string`, `address`: `string`) => `Promise`\<`boolean`\> | Injected BIP-322 verifier. Required unless `skipSignatureVerification`. | [`VerifyFederationBase`](VerifyFederationBase.mdx).[`verifyBip322`](VerifyFederationBase.mdx#property-verifybip322) | [agent-core/src/federation.ts:96](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L96) | diff --git a/src/pages/sdk/agent-core/interfaces/VerifyFederationRevocationInput.mdx b/src/pages/sdk/agent-core/interfaces/VerifyFederationRevocationInput.mdx new file mode 100644 index 0000000..ff97827 --- /dev/null +++ b/src/pages/sdk/agent-core/interfaces/VerifyFederationRevocationInput.mdx @@ -0,0 +1,26 @@ +export const metadata = { + title: "Interface: VerifyFederationRevocationInput", + description: "Auto-generated API reference for Interface: VerifyFederationRevocationInput. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / VerifyFederationRevocationInput + +# Interface: VerifyFederationRevocationInput + +Defined in: [agent-core/src/federation.ts:292](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L292) + +## Extends + +- [`VerifyFederationBase`](VerifyFederationBase.mdx) + +## Properties + +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| <a id="property-envelope"></a> `envelope` | [`FederationRevocationEnvelope`](FederationRevocationEnvelope.mdx) | - | - | [agent-core/src/federation.ts:293](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L293) | +| <a id="property-skipsignatureverification"></a> `skipSignatureVerification?` | `boolean` | - | [`VerifyFederationBase`](VerifyFederationBase.mdx).[`skipSignatureVerification`](VerifyFederationBase.mdx#property-skipsignatureverification) | [agent-core/src/federation.ts:97](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L97) | +| <a id="property-verifybip322"></a> `verifyBip322?` | (`msg`: `string`, `signatureB64`: `string`, `address`: `string`) => `Promise`\<`boolean`\> | Injected BIP-322 verifier. Required unless `skipSignatureVerification`. | [`VerifyFederationBase`](VerifyFederationBase.mdx).[`verifyBip322`](VerifyFederationBase.mdx#property-verifybip322) | [agent-core/src/federation.ts:96](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L96) | diff --git a/src/pages/sdk/agent-core/interfaces/VerifyOk.mdx b/src/pages/sdk/agent-core/interfaces/VerifyOk.mdx index e5bea21..1e4bbfa 100644 --- a/src/pages/sdk/agent-core/interfaces/VerifyOk.mdx +++ b/src/pages/sdk/agent-core/interfaces/VerifyOk.mdx @@ -11,7 +11,7 @@ export const metadata = { # Interface: VerifyOk\<T\> -Defined in: [agent-core/src/types.ts:259](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L259) +Defined in: [agent-core/src/types.ts:265](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L265) ## Type Parameters @@ -23,7 +23,7 @@ Defined in: [agent-core/src/types.ts:259](https://github.com/orangecheck/oc-pack | Property | Type | Defined in | | ------ | ------ | ------ | -| <a id="property-canonicalmessage"></a> `canonicalMessage` | `string` | [agent-core/src/types.ts:262](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L262) | -| <a id="property-envelope"></a> `envelope` | `T` | [agent-core/src/types.ts:261](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L261) | -| <a id="property-id"></a> `id` | `string` | [agent-core/src/types.ts:263](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L263) | -| <a id="property-ok"></a> `ok` | `true` | [agent-core/src/types.ts:260](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L260) | +| <a id="property-canonicalmessage"></a> `canonicalMessage` | `string` | [agent-core/src/types.ts:268](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L268) | +| <a id="property-envelope"></a> `envelope` | `T` | [agent-core/src/types.ts:267](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L267) | +| <a id="property-id"></a> `id` | `string` | [agent-core/src/types.ts:269](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L269) | +| <a id="property-ok"></a> `ok` | `true` | [agent-core/src/types.ts:266](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L266) | diff --git a/src/pages/sdk/agent-core/type-aliases/AgentErrorCode.mdx b/src/pages/sdk/agent-core/type-aliases/AgentErrorCode.mdx index 5dcbc83..a40c36f 100644 --- a/src/pages/sdk/agent-core/type-aliases/AgentErrorCode.mdx +++ b/src/pages/sdk/agent-core/type-aliases/AgentErrorCode.mdx @@ -38,7 +38,12 @@ type AgentErrorCode = | "E_SCOPES_BOTH_PROVIDED" | "E_SCOPES_NEITHER_PROVIDED" | "E_SCOPES_UNREADABLE" - | "E_BAD_LOCK_ENVELOPE"; + | "E_BAD_LOCK_ENVELOPE" + | "E_BAD_FEDERATION_DESCRIPTOR" + | "E_THRESHOLD_MISMATCH" + | "E_THRESHOLD_NOT_MET" + | "E_UNKNOWN_GUARDIAN" + | "E_DUPLICATE_GUARDIAN"; ``` Defined in: [agent-core/src/types.ts:231](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L231) diff --git a/src/pages/sdk/agent-core/type-aliases/FederationVerifyResult.mdx b/src/pages/sdk/agent-core/type-aliases/FederationVerifyResult.mdx new file mode 100644 index 0000000..cabc973 --- /dev/null +++ b/src/pages/sdk/agent-core/type-aliases/FederationVerifyResult.mdx @@ -0,0 +1,28 @@ +export const metadata = { + title: "Type Alias: FederationVerifyResult", + description: "Auto-generated API reference for Type Alias: FederationVerifyResult. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / FederationVerifyResult + +# Type Alias: FederationVerifyResult + +```ts +type FederationVerifyResult = + | { + canonicalMessage: string; + id: string; + ok: true; +} + | { + code: AgentErrorCode; + message: string; + ok: false; +}; +``` + +Defined in: [agent-core/src/federation.ts:90](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/federation.ts#L90) diff --git a/src/pages/sdk/agent-core/type-aliases/VerifyActionResult.mdx b/src/pages/sdk/agent-core/type-aliases/VerifyActionResult.mdx index 81cffb3..629adb1 100644 --- a/src/pages/sdk/agent-core/type-aliases/VerifyActionResult.mdx +++ b/src/pages/sdk/agent-core/type-aliases/VerifyActionResult.mdx @@ -17,4 +17,4 @@ type VerifyActionResult = | VerifyErr; ``` -Defined in: [agent-core/src/types.ts:292](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L292) +Defined in: [agent-core/src/types.ts:298](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L298) diff --git a/src/pages/sdk/agent-core/type-aliases/VerifyDelegationResult.mdx b/src/pages/sdk/agent-core/type-aliases/VerifyDelegationResult.mdx index 176cc92..e5ad389 100644 --- a/src/pages/sdk/agent-core/type-aliases/VerifyDelegationResult.mdx +++ b/src/pages/sdk/agent-core/type-aliases/VerifyDelegationResult.mdx @@ -17,4 +17,4 @@ type VerifyDelegationResult = | VerifyErr; ``` -Defined in: [agent-core/src/types.ts:272](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L272) +Defined in: [agent-core/src/types.ts:278](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L278) diff --git a/src/pages/sdk/agent-core/type-aliases/VerifyRevocationResult.mdx b/src/pages/sdk/agent-core/type-aliases/VerifyRevocationResult.mdx index 424c830..3e7a2cf 100644 --- a/src/pages/sdk/agent-core/type-aliases/VerifyRevocationResult.mdx +++ b/src/pages/sdk/agent-core/type-aliases/VerifyRevocationResult.mdx @@ -17,4 +17,4 @@ type VerifyRevocationResult = | VerifyErr; ``` -Defined in: [agent-core/src/types.ts:273](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L273) +Defined in: [agent-core/src/types.ts:279](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L279) diff --git a/src/pages/sdk/agent-core/type-aliases/VerifySubdelegationResult.mdx b/src/pages/sdk/agent-core/type-aliases/VerifySubdelegationResult.mdx index e990449..a487da1 100644 --- a/src/pages/sdk/agent-core/type-aliases/VerifySubdelegationResult.mdx +++ b/src/pages/sdk/agent-core/type-aliases/VerifySubdelegationResult.mdx @@ -17,4 +17,4 @@ type VerifySubdelegationResult = | VerifyErr; ``` -Defined in: [agent-core/src/types.ts:274](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L274) +Defined in: [agent-core/src/types.ts:280](https://github.com/orangecheck/oc-packages/blob/main/agent-core/src/types.ts#L280) diff --git a/src/pages/sdk/agent-core/variables/canonicalize.mdx b/src/pages/sdk/agent-core/variables/canonicalize.mdx new file mode 100644 index 0000000..e6caa5f --- /dev/null +++ b/src/pages/sdk/agent-core/variables/canonicalize.mdx @@ -0,0 +1,16 @@ +export const metadata = { + title: "Variable: canonicalize", + description: "Auto-generated API reference for Variable: canonicalize. Source: TypeScript types in oc-packages.", +}; + +[**@orangecheck/agent-core**](../README.mdx) + +*** + +[@orangecheck/agent-core](../README.mdx) / canonicalize + +# Variable: canonicalize + +```ts +canonicalize: any; +```