Skip to content

Commit 73a35ec

Browse files
committed
Merge branch 'main'
2 parents 3809b40 + a3bfd12 commit 73a35ec

File tree

218 files changed

+4126
-723
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

218 files changed

+4126
-723
lines changed

docs/api-reference/ability-sdk/functions/createVincentAbility.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: createVincentAbility
44

55
> **createVincentAbility**(`AbilityConfig`): [`VincentAbility`](/api-reference/ability-sdk/type-aliases/VincentAbility)\<`AbilityParamsSchema`, `PkgNames`, `PolicyMap`, `PolicyMapByPackageName`, `ExecuteSuccessSchema`, `ExecuteFailSchema`, `PrecheckSuccessSchema`, `PrecheckFailSchema`\>
66
7-
Defined in: [abilityCore/vincentAbility.ts:77](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityCore/vincentAbility.ts#L77)
7+
Defined in: [abilityCore/vincentAbility.ts:77](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityCore/vincentAbility.ts#L77)
88

99
The `createVincentAbility()` method is used to define an ability's lifecycle methods and ensure that arguments provided to the ability's
1010
lifecycle methods, as well as their return values, are validated and fully type-safe by defining ZOD schemas for them.

docs/api-reference/ability-sdk/functions/createVincentAbilityPolicy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: createVincentAbilityPolicy
44

55
> **createVincentAbilityPolicy**\<`VincentAbilityApiVersion`\>(`config`): `object`
66
7-
Defined in: [policyCore/vincentPolicy.ts:363](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/policyCore/vincentPolicy.ts#L363)
7+
Defined in: [policyCore/vincentPolicy.ts:363](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/policyCore/vincentPolicy.ts#L363)
88

99
`createVincentAbilityPolicy()` is used to bind a policy to a specific ability. You must provide a `abilityParameterMappings` argument
1010
which instructs the ability which of its abilityParams should be passed to the Vincent Policy during evaluation, and

docs/api-reference/ability-sdk/functions/createVincentPolicy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: createVincentPolicy
44

55
> **createVincentPolicy**(`PolicyConfig`): `object`
66
7-
Defined in: [policyCore/vincentPolicy.ts:56](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/policyCore/vincentPolicy.ts#L56)
7+
Defined in: [policyCore/vincentPolicy.ts:56](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/policyCore/vincentPolicy.ts#L56)
88

99
The `createVincentPolicy()` method is used to define a policy's lifecycle methods and ensure that arguments provided to the ability's
1010
lifecycle methods, as well as their return values, are validated and fully type-safe by defining ZOD schemas for them.

docs/api-reference/ability-sdk/functions/populateTransaction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: populateTransaction
44

55
> **populateTransaction**(`__namedParameters`): `Promise`\<`UnsignedTransaction`\>
66
7-
Defined in: [abilityHelpers/populateTransaction.ts:5](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityHelpers/populateTransaction.ts#L5)
7+
Defined in: [abilityHelpers/populateTransaction.ts:5](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityHelpers/populateTransaction.ts#L5)
88

99
## Parameters
1010

docs/api-reference/ability-sdk/functions/sponsoredGasContractCall.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: sponsoredGasContractCall
44

55
> **sponsoredGasContractCall**(`__namedParameters`): `Promise`\<`string`\>
66
7-
Defined in: [abilityHelpers/gasSponsorship/sponsored-gas-contract-call.ts:25](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityHelpers/gasSponsorship/sponsored-gas-contract-call.ts#L25)
7+
Defined in: [abilityHelpers/gasSponsorship/sponsored-gas-contract-call.ts:25](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityHelpers/gasSponsorship/sponsored-gas-contract-call.ts#L25)
88

99
Handler function for making contract calls
1010
This function handles the preparation, signing, and sending of contract transactions

docs/api-reference/ability-sdk/functions/sponsoredGasRawTransaction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: sponsoredGasRawTransaction
44

55
> **sponsoredGasRawTransaction**(`__namedParameters`): `Promise`\<`string`\>
66
7-
Defined in: [abilityHelpers/gasSponsorship/sponsored-gas-raw-transaction.ts:32](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityHelpers/gasSponsorship/sponsored-gas-raw-transaction.ts#L32)
7+
Defined in: [abilityHelpers/gasSponsorship/sponsored-gas-raw-transaction.ts:32](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityHelpers/gasSponsorship/sponsored-gas-raw-transaction.ts#L32)
88

99
Handler function for making raw transaction calls with gas sponsorship
1010
This function handles the preparation, signing, and sending of raw transactions

docs/api-reference/ability-sdk/functions/supportedPoliciesForAbility.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: supportedPoliciesForAbility
44

55
> **supportedPoliciesForAbility**\<`Policies`, `IpfsCid`, `VincentAbilityApiVersion`, `PkgNames`\>(`policies`): `AbilityPolicyMap`\<`Policies`, `PkgNames`\>
66
7-
Defined in: [abilityCore/helpers/supportedPoliciesForAbility.ts:56](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityCore/helpers/supportedPoliciesForAbility.ts#L56)
7+
Defined in: [abilityCore/helpers/supportedPoliciesForAbility.ts:56](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityCore/helpers/supportedPoliciesForAbility.ts#L56)
88

99
`supportedPoliciesForAbility()` takes an array of bundled Vincent Policies, and provides strong type inference for those policies
1010
inside of your VincentAbility's lifecycle functions and return values.

docs/api-reference/ability-sdk/interfaces/BaseAbilityContext.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: BaseAbilityContext
33
---
44

5-
Defined in: [abilityCore/abilityConfig/context/types.ts:18](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityCore/abilityConfig/context/types.ts#L18)
5+
Defined in: [abilityCore/abilityConfig/context/types.ts:18](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityCore/abilityConfig/context/types.ts#L18)
66

77
BaseAbilityContext is returned with ability execution results, and contains information about the app, delegation, and
88
policy evaluation results for any policies that the user had enabled for the ability.
@@ -19,7 +19,7 @@ policy evaluation results for any policies that the user had enabled for the abi
1919

2020
> **abilityIpfsCid**: `string`
2121
22-
Defined in: [types.ts:439](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L439)
22+
Defined in: [types.ts:439](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L439)
2323

2424
#### Inherited from
2525

@@ -31,7 +31,7 @@ Defined in: [types.ts:439](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
3131

3232
> **appId**: `number`
3333
34-
Defined in: [types.ts:440](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L440)
34+
Defined in: [types.ts:440](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L440)
3535

3636
#### Inherited from
3737

@@ -43,7 +43,7 @@ Defined in: [types.ts:440](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
4343

4444
> **appVersion**: `number`
4545
46-
Defined in: [types.ts:441](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L441)
46+
Defined in: [types.ts:441](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L441)
4747

4848
#### Inherited from
4949

@@ -55,7 +55,7 @@ Defined in: [types.ts:441](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
5555

5656
> **delegation**: `object`
5757
58-
Defined in: [types.ts:442](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L442)
58+
Defined in: [types.ts:442](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L442)
5959

6060
#### delegateeAddress
6161

@@ -87,4 +87,4 @@ Defined in: [types.ts:442](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
8787

8888
> **policiesContext**: `Policies`
8989
90-
Defined in: [abilityCore/abilityConfig/context/types.ts:19](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/abilityCore/abilityConfig/context/types.ts#L19)
90+
Defined in: [abilityCore/abilityConfig/context/types.ts:19](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/abilityCore/abilityConfig/context/types.ts#L19)

docs/api-reference/ability-sdk/interfaces/PolicyContext.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: PolicyContext
33
---
44

5-
Defined in: [policyCore/policyConfig/context/types.ts:41](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/policyCore/policyConfig/context/types.ts#L41)
5+
Defined in: [policyCore/policyConfig/context/types.ts:41](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/policyCore/policyConfig/context/types.ts#L41)
66

77
**`Expand`**
88

@@ -22,7 +22,7 @@ Defined in: [policyCore/policyConfig/context/types.ts:41](https://github.com/LIT
2222

2323
> **abilityIpfsCid**: `string`
2424
25-
Defined in: [types.ts:439](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L439)
25+
Defined in: [types.ts:439](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L439)
2626

2727
#### Inherited from
2828

@@ -34,15 +34,15 @@ Defined in: [types.ts:439](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
3434

3535
> **allow**: `AllowSchema` *extends* `ZodUndefined` ? () => `ContextAllowResponseNoResult` : (`result`) => `ContextAllowResponse`\<`TypeOf`\<`AllowSchema`\>\>
3636
37-
Defined in: [policyCore/policyConfig/context/types.ts:45](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/policyCore/policyConfig/context/types.ts#L45)
37+
Defined in: [policyCore/policyConfig/context/types.ts:45](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/policyCore/policyConfig/context/types.ts#L45)
3838

3939
***
4040

4141
### appId
4242

4343
> **appId**: `number`
4444
45-
Defined in: [types.ts:440](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L440)
45+
Defined in: [types.ts:440](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L440)
4646

4747
#### Inherited from
4848

@@ -54,7 +54,7 @@ Defined in: [types.ts:440](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
5454

5555
> **appVersion**: `number`
5656
57-
Defined in: [types.ts:441](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L441)
57+
Defined in: [types.ts:441](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L441)
5858

5959
#### Inherited from
6060

@@ -66,7 +66,7 @@ Defined in: [types.ts:441](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
6666

6767
> **delegation**: `object`
6868
69-
Defined in: [types.ts:442](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L442)
69+
Defined in: [types.ts:442](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L442)
7070

7171
#### delegateeAddress
7272

@@ -98,4 +98,4 @@ Defined in: [types.ts:442](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b0
9898

9999
> **deny**: `DenySchema` *extends* `ZodUndefined` ? () => `ContextDenyResponseNoResult` : (`result`, `runtimeError?`) => `ContextDenyResponse`\<`TypeOf`\<`DenySchema`\>\>
100100
101-
Defined in: [policyCore/policyConfig/context/types.ts:49](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/policyCore/policyConfig/context/types.ts#L49)
101+
Defined in: [policyCore/policyConfig/context/types.ts:49](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/policyCore/policyConfig/context/types.ts#L49)

docs/api-reference/ability-sdk/interfaces/SchemaValidationError.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22
title: SchemaValidationError
33
---
44

5-
Defined in: [types.ts:20](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L20)
5+
Defined in: [types.ts:20](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L20)
66

77
## Properties
88

99
### phase
1010

1111
> **phase**: `string`
1212
13-
Defined in: [types.ts:22](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L22)
13+
Defined in: [types.ts:22](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L22)
1414

1515
***
1616

1717
### stage
1818

1919
> **stage**: `string`
2020
21-
Defined in: [types.ts:23](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L23)
21+
Defined in: [types.ts:23](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L23)
2222

2323
***
2424

2525
### zodError
2626

2727
> **zodError**: `ZodError`\<`unknown`\>
2828
29-
Defined in: [types.ts:21](https://github.com/LIT-Protocol/Vincent/blob/4f61b0b06d818c2273457b0cc8a4e68ed21a72ed/packages/libs/ability-sdk/src/lib/types.ts#L21)
29+
Defined in: [types.ts:21](https://github.com/LIT-Protocol/Vincent/blob/698a2dc7f10a9fe630f16b6e2bb57f7b9ac0605c/packages/libs/ability-sdk/src/lib/types.ts#L21)

0 commit comments

Comments
 (0)