diff --git a/assets/navigation.js b/assets/navigation.js index edba196..ca71edb 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52Vy27CMBBF/8XrqA/oQ82uAlViVUSqbhALgwcyqmNHzhhBK/69EuGROA4xbON77xmP7cn0jxFsiMXMWEWYAYtYzillMcu0sBKK+8PCXUqZZBH7QSVY3IvYIkUpDCgWT08hAvOx0WsUYAZcyuKctuYG+bya52rrgH5vN9tFp+AC5xLVqlndYSGouiHmSSkfG62XI5VbOifSNq/k+bQO5OHt9fG5VylyBQoMJxhi/m4p1QZ/QXxtPrRJ3PKXVi0ItToDO811+stTrT+WsNrtY3f2n0N7M9BZhpSBov2WP3Mq3O6UeX5tV3eargkEAyYQkj9EkeBKcbIGBloVNgNzcRtthitZwYwbso9vJJhRNVzJunQgji4geSRAEdK2+zY1lNemXyrcFXZlH/uXECeYaN31Gtr1t5Fa99Iq7+IIWHIr6ZtLC96RXObXZI1p7B1zziv1zbcyu93TGGteUPX2BVGqhjBE7Z4EMWqOAIj/ALtRfp/nfzD7Bx8Vl8XPBwAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42PyQ6CQBBE/6XPRJS4RI5GY7wZPBoPAzbQAXomTJNgjP9uPLkNy73qvarzHQRbgRC2ZE4Ul8TZRlk81lqnBzaNgAdGSQ4hyM2g9btyk1yqEjwoiK8QBtP1arYIHl4fP0I7gh6hHWLvkbFWgq92E1ckouISd63UxJYS548xnSFv9sH4Wf3WpQ0nQpqt3xP/Ni3nHRLH0CGRo/InuzwB8FpvlgcCAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index cdfdcad..f19c7fd 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71cS2/bSBL+L5wrV6N+8OVbNsFgfJkdOLOZg2AEtMjEhCVKoChPvIb/+4JkU6qiusjuFp2TYLu6+qv66tEv+dWrdv8cvJvVq/dUlJl3w32vTLe5d+NVx7Iutrnne8dq491421123OSHX9XvF4/1duP53nqTHg75wbvxvDe/1yLOarJi/2e1ey6yvPqYbjaHk77ntCrSB6hxKKqZwvf2aZWXNcB3nvU86aF42BTl9wvs6vej2EN5UvM9L/MqrfNPxf7DsX7cVcX/8uyvH7/tqs+DCb4dy3Vd7MrzFJNjx63rLQDWLZOIBWcbPxV7penParf7dlvuj/UJT/2yB+bqRG2nD4NAhKfJv35tZrCd7pfTsNFZtQoAFLbkZ47W6WbjiGOhxtqDWShDKEy78nDc5tWHfeEMDamYHWFWZP+tnMGdRs+O6yl/uc0OrrhOo2fHtW8Ev+TVodiVrugGOt4DY1s7r4g6rGJ2hFW+SV+ugAfGz47tUHwv88oV2Wn0/LiOD9uirvPqQ5ZV+cE5NzR63iN77/JN2jbCx2J/RRoP1MyO9GGzWz/9nhffH617Zo8Sq5gdYbN+OBSH39PDoytCrOLd6s2/r/elXtXsiNP1encs69vsrls7/uW+hlkQut4nUv84bh/yagbUpLbZcRdZXtZF/fIpr9Nic5gB+6jG+fGX680xy//OH8Qf6dYd9IWa2ZFuivIpzz508ejcHy60zIHzvFs51gXY+/X7sfa3truxfo/4uU7r/G63q1sEmq1Yp3182Pg2qEM9tTf8uNtui3qbl4ZILofMgeJWpYcxBjRgDgSfiuxz8b1M62OVmwCA8nbzw/OF/Ft63NRf0s0x1x0udLMiKUtbxza+0/NM7Xk145zalzESu86lU3ZVwzLHadmr7JEatChztA7dyQEx0ZQsYBr2I3tsRBsyh2bYgYyQDQ/L9MX/P/uLftlpp8VnrB0WE5oVkREjrY8MbGAZHRtMKnQ6OrCCOXl8cCXG6Q2Rk1dNNkX2yM0y5C63SZC7WXur+XzXpMcd3W/3aCVlDWfRj3cC9a6xpkE6S6hN425zcB7QGlUzIdZctQwW7GTn0Iu+U1aMTGaWEoRhNpcGpkimLg1G9bgefBuDM+9gVyHsovXySM8aJ1Q0O9pn7T2HMcbniSsOO2TTuUj1KK3kT8tEu96kt8q6L03CMOpJei0mzKAjhbEaeSH4frzopzKm5dIkp+o4isK4Nl5qcbhONcQ0cZnqjGn8YNUQnN021gHl6KGqIUirDa0DRoO+Nw7QquvZopvoIuPIjHuIAaqpOjXSP4ZyP6lKWfeOC3tcOscYBNO+caHjgo25nNIhUvr/xZyhKcvIw8yizPJsBoCLs6prgE5ur57zdDMPYKDrPRHvdvpN4BRaNfDqgNSUB3gx0W8bx1YzlPz7lYvRGY3LBmmn0xLHBJPxSodU5vCKxw7hxFOeaxGOv5Gxg2r6UMYB80RWfFTPE02zAsr/nKy4mNEpK5Cd7q9KrBC6XNCNqZ54E0MvHs3AmqwdHbEZvX2xg+t0qehugeZ1sh3e0SfK16IzfqNjh9n5KtTdkolXknb4jZ9KzhLfI+fgVkFtdAjujpV+j2iH1eRRogPWiX5l2qd+Xn+6ri+N9aP+qwMuKBZgsCUcw8MKJ1Rg8NWoJiJl5DRgIPZz4sT6LGBozHRvdYCxwMPtIBms4fEbMgtccPCsqBz5WjiRdsJy73vNqcEP7+b1dKB24/GFWCSe730r8k3WfHuvA+l76922ObP37tXfvuTrelc1Ep3Ir0vPXy19yRYylvf3/qof0f6h/UUrxjx/xXRiDIlxz19xnRhHYsLzV0InJpCY9PyV1IlJJBZ4/irwWbIIGEdiARILPX8V+iJciChEYiESizx/FekmjZBY7Pmr2BfLhUxiJBYjscTzV4lu0gS7t/E20/LABkS0TDDdzAxzwRqfM66bnGE6WON2JrSSmBHWeJ5JrSQmhTXOZ4FWEvPCGv8zLTMMU8MaCliklcTssIYFFvtCLJaMYUlMEGuIYIlWEnPEGyL4UifJMUe8IYIzreQgX9qE4VpJzBFviOBCK4k54g0RXJs3HHPEGyJ4oJXEHPGGCB5qJTFHvCGCaxOIY454QwSPtZKYI94QwROtJOZILKlaIDBFgpG0C0yR4CTtYlDVBEm7wBQJSdIuMEUiIGkXmCLR8CC0JURgikREOgkzJGKy1gjMkEjIWiMwQ3JJZqbEFMmGB6FtOhJTJDllkMQMybbxaP0uB61H0jAxQ7KhQWi7mcQMyZYhfUPDDEmSIYkZkmQbkpggmZBUSkxQ0LAgtEUhwAQFLUHawh1ggoKGBqEtCgFmKBBkM8cEBZKkMhgsD1qCtHUmwAQFITk55ieIKLcHmJ8gpvp/gPkJErIiBJifcElWhBDzE9JLhRDzE3KSyRDzE7YZpC3FISYolJQzQ8xPGJBMhoMVHMlPiPkJGxakthaGmKCwoUFqi0yIGQobGqR2cRtihqKGBqmtCBFmKGKUQREmKOJUwEWYn4heykWYn0iSC7QIExQ1LEht3YowQRFJUDRYZEdk+40wQVFLkLYcRZigKCEbdYQJipfUViDG/MT0Qi7GBMWcXBjHmKFYkMvdGDMUS3K5G2OG4pYh7fIsxgzFJEMxZihuU0hbsuPBTqhlSFtfY8xQ3KaQtnjEmKGEXMclmKGkzSBtpieYoaRdJGgzPcEMJW0P0mZ60jHUbsKf86rOs9tuM75anU5wXr2vaoce9GcFr17g3by++Z5Yqs+o+5RcfaqfA6E+w+4zlOpT/Rwx9al+jtVn0up9O+/3m58a4OrmqMjUP8cZQmTJGSNLFLh+kohS2tzwnHVIYGcUE2NOjx3AuOV5XEjN1R4rPaqTbIA7BLh7Z4gxHaU6mgL0gPkTNj2WcCEHanjPr+I1Sgi13S3OWQkwp7eGovR8IAtcGZ3Hx5Qr+4ED+sBQaqT6btWz+kolsB2ED6dszYrsWKEpY4BWJYD6DFQiRJxUtl+fnqK2z0l27Un+WbmQZ+0yNFZTYcsEcEswAiYrstMJY+/gISIJEEWBma4LHSBCYkMd/SH5hS4B8FBhNtA1cI8ExMc08fv+5k/PFIiDYMQmpGTIEwASUgUgK/a9L9bdvxwDlQQUEnq4+pZ7i6Do/rEWcAYIOEJF/yXnrNinp3/+Vf/4tqtO/5kM2HTWR1kE9A3iGKUnCBpOpQJQBQlHegBRnKrwQA8iDCkCWcWpatMr6ik7NN/PaR53XaoDnYdTAaTuFx/b+0XAO4DCVNWJKfp6g7LuApvqBCCWuGqiQnX0mAou9XD5n/xBdGf2QB8H+lRHEWpFEFBJ95S/FBmKcJAhqsMHFIdP+UuF3g8BfwFfM7WciSh/dQ+d09NDZ2ATCG6ufCOUupCqRRfEC+AZ2a+Z+rUSFQitltM7YmAZaOBsBIK6cAR5D/sY5dJ+4KDrMlh3+ljpm6GiKaRiptfZLY4GgS3gsnPKHGp5BSxjPSq1tpEU6fp8vSj6wNuCqkl6VcPSD1woKVe13wkc+h5ED+vzisqnVgHhJgGCWVJhd341CyIHQA+pyOnes4JBAHZIwu3/Sed5HHA4FQ6aJgRrDzlK0ysCYFoyNhLnEgOuZCqjI6r7nd7jpP17HKAIdGOmSkJM4bjYsQGrE2r27iIfugpMyans0BQeAdpzoGpAqIV673v7Yp9vijL3blb3b2//B6RtW3qnVQAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VYXY/aOhD9L9NXK4udDyBv7b1Vuy9V1aq9DxFahXh21yIkURK2XSH++5UTSGywgWTZJ7TLnOPjOZ4Z4y2U+Z8KwmgLK5FxCAOPQBavEUJ4wgzLuMZ/RfFTLFORPX2KK/xe5vkjENiUKYTwuMmSWuRZdXcm2nmu1ykQSNK4qrCCEGBHLiy4Wa5FXcfLFD//rUuRVSK5sKgBcXZhNplPqc+61Q3C77NiU3fL1q8FVne2sPOb9H036FZ6eJBUQ3g/dBCFnkARl5jV57T3EuiE9Znmgv8qxQgFToccJsTZb8CiZ4Wv97wao6dD3lRPIQN/Y1mJPBuj6gh/a20vgmP5sRhloA6/qbIS0/h1pCwFe3tNn9I8WX1F8fQ8qJo1bTrHTTWKLEk3HP/DpftN/meExFOKmypMRbZC/jFJ8k1Wj6rTE4a36ruiff/AK6T+wOodWveBdUTjlqovlP5XjLk+h68V4pgohki7cFC4KP7J12tRrzGrR0o0ctxW43hl76Bn2LAxGDpq1Bh1HRfVl/P3K9P96BrIWwvu6jUuld9V+7PYFnMu5C00Tpt8fk5RntfjjjNUqmOnHb+FCwcwPhnZw1Wfmdw3ULiMKwk3le1gqUdc76Y5idP0rVr3HO+m0fg7YLDKC78JBulcEBAZx78QbuFl39VCYI7rzIHAo8CUy5+r7QYIJPlalgcs9t/9xqTOSxnRhtxNgEQTwmaOz4LFgkQHRPNF848mjAKJqCmMamEMSMRMYUwLc4FELmETZ+K7WpirhXlAIo8w1/HoTAvztDAfSOSbFvW1sABIFJjYAi1sCiSamtimWtgMSDQzhc20sDmQaG4Km+vpldmmRh/okRGNE2YrdC+ozDk1ukF1O6jVD6obQmXiqWuk1D2hMvfUM0bqtlCZfmr0j+rO0KnNQap7Q6UHNDBS6vbQuXXnukGsMch4LphuEGsMMh4NdlQsjUHG08F0g5i0gRmPB9MdYtaaYa1BTf94wbJGft/2kSjqLhFbeNg3F/fQArfgQrjdEaCHz7n83PWtRf4lF+oHc3Plwm4w96x02tOyiY1HjkoFM1Mw1IKRM4uLomhnlgKeK2BmAbdDpAexiQJyLSAu+KbUhHo9ymtTxTwruEi6G/ypaIWJ+naKU6CvAAM7sGqvujJpDYdor6lKBpQEXE9Tom62wkJtNIcHSgOdyqU4Yjs2KlM/RbF/HFWUKcLGsZ1kjAYK58xCun+E+INLtx3PCl7ZIbVtcYWvgms5Vgy3HZT2YSHuHhaUNdU82BLRWHG4aChgZb/BvjFM7RTNT+qjwlZ6wSXkM8b89LQrPYraKq15mjpaWGkoNqca2FK+aD3vX7R6uNJSjK1wQaAQBaYiQwijxW73P5XMsBBEGAAA"; \ No newline at end of file diff --git a/functions/generateDipSiblingBaseProof.html b/functions/generateDipSiblingBaseProof.html new file mode 100644 index 0000000..1281266 --- /dev/null +++ b/functions/generateDipSiblingBaseProof.html @@ -0,0 +1,7 @@ +generateDipSiblingBaseProof | API Documentation

Function generateDipSiblingBaseProof

  • generateDipSiblingBaseProof(params): Promise<DipSiblingBaseProofRes>

  • Generate a base DIP proof according to the parameters provided, to be used on a consumer chain of which the provider chain is a sibling.

    +

    The generated proof only contains parts of the DID Document of the subject. +Any additional components that the consumer chain requires, e.g., a cross-chain DID signature, or the presentation of some claims about the subject, are not part of the generated proof. +This SDK contains an extensions section in which chain-specific proof formats could be added, if needed.

    +

    Parameters

    Returns Promise<DipSiblingBaseProofRes>

    The [[DipSiblingBaseProofRes]] containing the basic DIP proof components revealing parts of a DID Document anchored to a specific state root and block number on the provider chain, without any consumer-specific logic.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/utils.ProviderStateRootProofRes.html b/functions/generateDipSubmittableExtrinsic.html similarity index 68% rename from types/utils.ProviderStateRootProofRes.html rename to functions/generateDipSubmittableExtrinsic.html index e09ca50..6727a91 100644 --- a/types/utils.ProviderStateRootProofRes.html +++ b/functions/generateDipSubmittableExtrinsic.html @@ -1,5 +1,4 @@ -ProviderStateRootProofRes | API Documentation

Type alias ProviderStateRootProofRes

ProviderStateRootProofRes: {
    proof: ReadProof;
    providerBlockHeight: BN;
    relayBlockHeight: BN;
}

The response object containing the provider state root proof.

-

Type declaration

  • proof: ReadProof

    The state proof for the provider header.

    -
  • providerBlockHeight: BN

    The block number of the provider which the proof is anchored to.

    -
  • relayBlockHeight: BN

    The block number of the relaychain which the proof is anchored to.

    -

Settings

Member Visibility

Theme

\ No newline at end of file +generateDipSubmittableExtrinsic | API Documentation

Function generateDipSubmittableExtrinsic

  • generateDipSubmittableExtrinsic(params): SubmittableExtrinsic

  • Extend a [[DipSiblingBaseProofRes]] proof with consumer-specific components, and compiles the dispatchAs extrinsic following the consumer's type registry.

    +

    Parameters

    Returns SubmittableExtrinsic

    A [[SubmittableExtrinsic]] that refers to a [[Call]] on the consumer chain being dispatched by the specified [[DidUri]].

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/sibling.generateDipAuthorizedTxForSibling.html b/functions/sibling.generateDipAuthorizedTxForSibling.html deleted file mode 100644 index 7abf6b4..0000000 --- a/functions/sibling.generateDipAuthorizedTxForSibling.html +++ /dev/null @@ -1,4 +0,0 @@ -generateDipAuthorizedTxForSibling | API Documentation

Function generateDipAuthorizedTxForSibling

  • generateDipAuthorizedTxForSibling(params): Promise<SubmittableExtrinsic>

  • Generate a submittable extrinsic for the provided call which includes a complete DIP proof according to the parameters provided, to be used on a consumer chain of which the provider chain is a sibling.

    -

    Parameters

    Returns Promise<SubmittableExtrinsic>

    The SubmittableExtrinsic containing the signed cross-chain operation, that must be submitted by the account specified as the submitterAddress parameter.

    -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/utils.generateDipCommitmentProof.html b/functions/utils.generateDipCommitmentProof.html deleted file mode 100644 index 71a5455..0000000 --- a/functions/utils.generateDipCommitmentProof.html +++ /dev/null @@ -1,4 +0,0 @@ -generateDipCommitmentProof | API Documentation

Function generateDipCommitmentProof

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/utils.generateDipDidSignature.html b/functions/utils.generateDipDidSignature.html deleted file mode 100644 index 8a57fbb..0000000 --- a/functions/utils.generateDipDidSignature.html +++ /dev/null @@ -1,4 +0,0 @@ -generateDipDidSignature | API Documentation

Function generateDipDidSignature

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/utils.generateDipIdentityProof.html b/functions/utils.generateDipIdentityProof.html deleted file mode 100644 index 4c98c51..0000000 --- a/functions/utils.generateDipIdentityProof.html +++ /dev/null @@ -1,4 +0,0 @@ -generateDipIdentityProof | API Documentation

Function generateDipIdentityProof

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/utils.generateProviderStateRootProof.html b/functions/utils.generateProviderStateRootProof.html deleted file mode 100644 index 3cb191a..0000000 --- a/functions/utils.generateProviderStateRootProof.html +++ /dev/null @@ -1,4 +0,0 @@ -generateProviderStateRootProof | API Documentation

Function generateProviderStateRootProof

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/index.html b/index.html index 3f51542..928c11d 100644 --- a/index.html +++ b/index.html @@ -30,4 +30,4 @@
  • In a new shell session, run the end-to-end tests with yarn test:e2e:peregrine-provider or yarn test:e2e:dip-template-provider.
  • [OPTIONAL] Tear down the network by killing the process started at step 4.
    • -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..3d2563a --- /dev/null +++ b/modules.html @@ -0,0 +1,6 @@ +API Documentation

    API Documentation

    Index

    Type Aliases

    DipSiblingBaseProofInput +DipSiblingBaseProofRes +GenerateDipSubmittableExtrinsicInput +

    Functions

    generateDipSiblingBaseProof +generateDipSubmittableExtrinsic +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/runtime.html b/modules/runtime.html deleted file mode 100644 index 893def7..0000000 --- a/modules/runtime.html +++ /dev/null @@ -1,2 +0,0 @@ -runtime | API Documentation

    Module runtime

    Index

    Variables

    dipProviderCalls -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/sibling.html b/modules/sibling.html deleted file mode 100644 index af13197..0000000 --- a/modules/sibling.html +++ /dev/null @@ -1,3 +0,0 @@ -sibling | API Documentation

    Module sibling

    Index

    Type Aliases

    DipSiblingProofInput -

    Functions

    generateDipAuthorizedTxForSibling -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/utils.html b/modules/utils.html deleted file mode 100644 index a721e72..0000000 --- a/modules/utils.html +++ /dev/null @@ -1,16 +0,0 @@ -utils | API Documentation

    Module utils

    Index

    Type Aliases

    DipCommitmentProofOpts -DipCommitmentProofRes -DipDidSignatureConsumerOpts -DipDidSignatureOpts -DipDidSignatureProviderOpts -DipDidSignatureRes -DipIdentityProofOpts -DipIdentityProofRes -ProviderStateRootProofOpts -ProviderStateRootProofRes -

    Variables

    defaultValues -

    Functions

    generateDipCommitmentProof -generateDipDidSignature -generateDipIdentityProof -generateProviderStateRootProof -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DipSiblingBaseProofInput.html b/types/DipSiblingBaseProofInput.html new file mode 100644 index 0000000..ae14ec5 --- /dev/null +++ b/types/DipSiblingBaseProofInput.html @@ -0,0 +1,10 @@ +DipSiblingBaseProofInput | API Documentation

    Type alias DipSiblingBaseProofInput

    DipSiblingBaseProofInput: {
        didUri: DidUri;
        includeWeb3Name?: boolean;
        keyIds: DidKey["id"][];
        linkedAccounts?: readonly PalletDidLookupLinkableAccountLinkableAccountId[];
        proofVersion: number;
        providerApi: ApiPromise;
        relayApi: ApiPromise;
        relayBlockHeight?: BN;
    }

    The DIP proof params.

    +

    Type declaration

    • didUri: DidUri

      The DID URI of the DIP subject that is performing the cross-chain operation.

      +
    • Optional includeWeb3Name?: boolean

      Flag indicating whether the generated DIP proof should include the web3name of the DID subject. If not provided, the web3name is not revealed.

      +
    • keyIds: DidKey["id"][]

      The verification method IDs of the DID to be revealed in the cross-chain operation.

      +
    • Optional linkedAccounts?: readonly PalletDidLookupLinkableAccountLinkableAccountId[]

      The list of linked accounts to reveal in the generated DIP proof. If not provided, no account is revealed.

      +
    • proofVersion: number

      The version of the DIP proof to generate.

      +
    • providerApi: ApiPromise

      The ApiPromise instance for the provider chain.

      +
    • relayApi: ApiPromise

      The ApiPromise instance for the parent relay chain.

      +
    • Optional relayBlockHeight?: BN

      The block number of the relay chain to use for the generation of the DIP proof. If not provided, the last finalized block is used.

      +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DipSiblingBaseProofRes.html b/types/DipSiblingBaseProofRes.html new file mode 100644 index 0000000..36f3df1 --- /dev/null +++ b/types/DipSiblingBaseProofRes.html @@ -0,0 +1,2 @@ +DipSiblingBaseProofRes | API Documentation

    Type alias DipSiblingBaseProofRes

    DipSiblingBaseProofRes: {
        dipCommitmentProof: DipCommitmentProofRes;
        dipProof: DipIdentityProofRes;
        proofVersion: number;
        providerHeadProof: ProviderStateRootProofRes;
    }

    The DIP proof result.

    +

    Type declaration

    • dipCommitmentProof: DipCommitmentProofRes
    • dipProof: DipIdentityProofRes
    • proofVersion: number
    • providerHeadProof: ProviderStateRootProofRes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GenerateDipSubmittableExtrinsicInput.html b/types/GenerateDipSubmittableExtrinsicInput.html new file mode 100644 index 0000000..d46d73d --- /dev/null +++ b/types/GenerateDipSubmittableExtrinsicInput.html @@ -0,0 +1,7 @@ +GenerateDipSubmittableExtrinsicInput | API Documentation

    Type alias GenerateDipSubmittableExtrinsicInput

    GenerateDipSubmittableExtrinsicInput: {
        additionalProofElements: Record<any, any>;
        api: ApiPromise;
        baseDipProof: DipSiblingBaseProofRes;
        call: Call;
        didUri: DidUri;
    }

    The params to create an extrinsic containing a cross-chain DIP proof and operation.

    +

    Type declaration

    • additionalProofElements: Record<any, any>

      Any consumer-specific pieces of information to be included in the DIP proof beyond proof-of-DID.

      +
    • api: ApiPromise

      The [[ApiPromise]] instance of the consumer chain.

      +
    • baseDipProof: DipSiblingBaseProofRes

      [[DipSiblingBaseProofRes]] as generated by [[generateDipSiblingBaseProof]].

      +
    • call: Call

      The [[Call]] on the consumer chain that requires a DIP origin to be authorized.

      +
    • didUri: DidUri

      The [[DidUri]] of the subject performing the cross-chain operation.

      +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/sibling.DipSiblingProofInput.html b/types/sibling.DipSiblingProofInput.html deleted file mode 100644 index f02b6c7..0000000 --- a/types/sibling.DipSiblingProofInput.html +++ /dev/null @@ -1,20 +0,0 @@ -DipSiblingProofInput | API Documentation

    Type alias DipSiblingProofInput

    DipSiblingProofInput: {
        accountIdRuntimeType?: string;
        blockHeight?: BN;
        blockNumberRuntimeType?: string;
        call: Call;
        consumerApi: ApiPromise;
        didUri: DidUri;
        genesisHash?: Hash;
        identityDetailsRuntimeType?: string;
        includeWeb3Name?: boolean;
        keyIds: DidKey["id"][];
        keyRelationship: VerificationKeyRelationship;
        linkedAccounts?: readonly PalletDidLookupLinkableAccountLinkableAccountId[];
        proofVersion: number;
        providerApi: ApiPromise;
        providerBlockHeight?: BN;
        relayApi: ApiPromise;
        signer: SignExtrinsicCallback;
        submitterAddress: KeyringPair["address"];
    }

    The DIP proof params.

    -

    Type declaration

    • Optional accountIdRuntimeType?: string

      The runtime type definition for an AccountId on the consumer chain. If not provided, the AccountId type is used.

      -
    • Optional blockHeight?: BN

      The block number on the consumer chain to use for the DID signature. If not provided, the latest best block number is used.

      -
    • Optional blockNumberRuntimeType?: string

      The runtime type definition for a BlockNumber on the consumer chain. If not provided, the u64 type is used.

      -
    • call: Call

      The Call on the consumer chain that requires a DIP origin.

      -
    • consumerApi: ApiPromise

      The ApiPromise instance for the consumer chain.

      -
    • didUri: DidUri

      The DID URI of the DIP subject that is performing the cross-chain operation.

      -
    • Optional genesisHash?: Hash

      The genesis hash of the consumer chain to use for the DID signature. If not provided, it is retrieved at runtime from the consumer chain.

      -
    • Optional identityDetailsRuntimeType?: string

      The runtime type definition for the IdentityDetails on the consumer chain. If not provided, the Option<u128> type, representing a simple nonce, is used.

      -
    • Optional includeWeb3Name?: boolean

      Flag indicating whether the generated DIP proof should include the web3name of the DID subject. If not provided, the web3name is not revealed.

      -
    • keyIds: DidKey["id"][]

      The verification method IDs of the DID to be revealed in the cross-chain operation.

      -
    • keyRelationship: VerificationKeyRelationship

      The VerificationKeyRelationship required for the DIP operation to be authorized on the relay chain.

      -
    • Optional linkedAccounts?: readonly PalletDidLookupLinkableAccountLinkableAccountId[]

      The list of linked accounts to reveal in the generated DIP proof. If not provided, no account is revealed.

      -
    • proofVersion: number

      The version of the DIP proof to generate.

      -
    • providerApi: ApiPromise

      The ApiPromise instance for the provider chain.

      -
    • Optional providerBlockHeight?: BN

      The block number of the provider to use for the generation of the DIP proof. If not provided, the latest finalized block number is used.

      -
    • relayApi: ApiPromise

      The ApiPromise instance for the parent relay chain.

      -
    • signer: SignExtrinsicCallback

      The signing callback to sign the cross-chain transaction.

      -
    • submitterAddress: KeyringPair["address"]

      The address of the tx submitter on the consumer chain.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipCommitmentProofOpts.html b/types/utils.DipCommitmentProofOpts.html deleted file mode 100644 index c5d3b86..0000000 --- a/types/utils.DipCommitmentProofOpts.html +++ /dev/null @@ -1,6 +0,0 @@ -DipCommitmentProofOpts | API Documentation

    Type alias DipCommitmentProofOpts

    DipCommitmentProofOpts: {
        didUri: DidUri;
        providerApi: ApiPromise;
        providerBlockHash: Hash;
        version: number;
    }

    The options object provided when generating a DIP commitment proof.

    -

    Type declaration

    • didUri: DidUri

      The DidUri of the subject.

      -
    • providerApi: ApiPromise

      The ApiPromise instance for the provider chain.

      -
    • providerBlockHash: Hash

      The block hash on the provider chain to use for the state proof.

      -
    • version: number

      The version of the identity commitment to generate the state proof for.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipCommitmentProofRes.html b/types/utils.DipCommitmentProofRes.html deleted file mode 100644 index 61b7bca..0000000 --- a/types/utils.DipCommitmentProofRes.html +++ /dev/null @@ -1,3 +0,0 @@ -DipCommitmentProofRes | API Documentation

    Type alias DipCommitmentProofRes

    DipCommitmentProofRes: {
        proof: ReadProof;
    }

    The response object for a DIP commitment proof.

    -

    Type declaration

    • proof: ReadProof

      The storage proof for the DIP commitment value.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipDidSignatureConsumerOpts.html b/types/utils.DipDidSignatureConsumerOpts.html deleted file mode 100644 index f36886b..0000000 --- a/types/utils.DipDidSignatureConsumerOpts.html +++ /dev/null @@ -1,10 +0,0 @@ -DipDidSignatureConsumerOpts | API Documentation

    Type alias DipDidSignatureConsumerOpts

    DipDidSignatureConsumerOpts: {
        accountIdRuntimeType: string;
        api: ApiPromise;
        blockHeight?: BN;
        blockNumberRuntimeType: string;
        call: Call;
        genesisHash?: Hash;
        identityDetailsRuntimeType: string;
        submitterAddress: KeyringPair["address"];
    }

    The Consumer options object provided when generating a DIP DID signature.

    -

    Type declaration

    • accountIdRuntimeType: string

      The runtime definition of an AccountId.

      -
    • api: ApiPromise

      The ApiPromise instance.

      -
    • Optional blockHeight?: BN

      The block number to use for the DID signature. If not provided, the latest best block number is used.

      -
    • blockNumberRuntimeType: string

      The runtime definition of a BlockNumber.

      -
    • call: Call

      The Call to DID-authorize.

      -
    • Optional genesisHash?: Hash

      The genesis hash to use for the DID signature. If not provided, it is retrieved at runtime.

      -
    • identityDetailsRuntimeType: string

      The runtime definition of the IdentityDetails.

      -
    • submitterAddress: KeyringPair["address"]

      The address of the submitter account on the consumer chain.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipDidSignatureOpts.html b/types/utils.DipDidSignatureOpts.html deleted file mode 100644 index 34bfe77..0000000 --- a/types/utils.DipDidSignatureOpts.html +++ /dev/null @@ -1,2 +0,0 @@ -DipDidSignatureOpts | API Documentation

    Type alias DipDidSignatureOpts

    DipDidSignatureOpts: {
        consumer: DipDidSignatureConsumerOpts;
        provider: DipDidSignatureProviderOpts;
    }

    The options object provided when generating a DIP DID signature.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipDidSignatureProviderOpts.html b/types/utils.DipDidSignatureProviderOpts.html deleted file mode 100644 index 53b6467..0000000 --- a/types/utils.DipDidSignatureProviderOpts.html +++ /dev/null @@ -1,5 +0,0 @@ -DipDidSignatureProviderOpts | API Documentation

    Type alias DipDidSignatureProviderOpts

    DipDidSignatureProviderOpts: {
        didUri: DidUri;
        keyRelationship: VerificationKeyRelationship;
        signer: SignExtrinsicCallback;
    }

    The Provider options object provided when generating a DIP DID signature.

    -

    Type declaration

    • didUri: DidUri

      The DidUri of the DIP subject that is performing the cross-chain operation.

      -
    • keyRelationship: VerificationKeyRelationship

      The SignatureVerificationRelationship to use from the provided DID Document to sign the cross-chain payload.

      -
    • signer: SignExtrinsicCallback

      The list of Signers to use to sign the cross-chain payload.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipDidSignatureRes.html b/types/utils.DipDidSignatureRes.html deleted file mode 100644 index 4bfbea2..0000000 --- a/types/utils.DipDidSignatureRes.html +++ /dev/null @@ -1,2 +0,0 @@ -DipDidSignatureRes | API Documentation

    Type alias DipDidSignatureRes

    DipDidSignatureRes: {
        blockNumber: BN;
        signature: Uint8Array;
        type: VerificationKeyType;
    }

    The response object for DIP DID signature.

    -

    Type declaration

    • blockNumber: BN
    • signature: Uint8Array
    • type: VerificationKeyType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipIdentityProofOpts.html b/types/utils.DipIdentityProofOpts.html deleted file mode 100644 index 1e40897..0000000 --- a/types/utils.DipIdentityProofOpts.html +++ /dev/null @@ -1,8 +0,0 @@ -DipIdentityProofOpts | API Documentation

    Type alias DipIdentityProofOpts

    DipIdentityProofOpts: {
        didUri: DidUri;
        includeWeb3Name: boolean;
        keyIds: DidKey["id"][];
        linkedAccounts: readonly PalletDidLookupLinkableAccountLinkableAccountId[];
        providerApi: ApiPromise;
        version: number;
    }

    The options object provided when generating a DIP identity proof.

    -

    Type declaration

    • didUri: DidUri

      The Did of the subject.

      -
    • includeWeb3Name: boolean

      A flag indicating whether the web3name should be included in the DIP proof.

      -
    • keyIds: DidKey["id"][]

      The list of DID verification methods to include in the DIP proof and to reveal to the consumer chain.

      -
    • linkedAccounts: readonly PalletDidLookupLinkableAccountLinkableAccountId[]

      The list of accounts linked to the DID ot include in the DIP proof and to reveal to the consumer chain.

      -
    • providerApi: ApiPromise

      The ApiPromise instance for the provider chain.

      -
    • version: number

      The version of the DIP proof to generate.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.DipIdentityProofRes.html b/types/utils.DipIdentityProofRes.html deleted file mode 100644 index 036af53..0000000 --- a/types/utils.DipIdentityProofRes.html +++ /dev/null @@ -1,6 +0,0 @@ -DipIdentityProofRes | API Documentation

    Type alias DipIdentityProofRes

    DipIdentityProofRes: {
        proof: {
            blinded: Codec;
            revealed: Codec;
        };
        root: Hash;
    }

    The response object for a generated DIP proof.

    -

    Type declaration

    • proof: {
          blinded: Codec;
          revealed: Codec;
      }

      The generated storage proof.

      -
      • blinded: Codec

        The Merkle proof blinded (not revealed) leaves.

        -
      • revealed: Codec

        The Merkle proof revealed leaves.

        -
    • root: Hash

      The Merkle root hash which the proof is anchored to.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/utils.ProviderStateRootProofOpts.html b/types/utils.ProviderStateRootProofOpts.html deleted file mode 100644 index e7be5f5..0000000 --- a/types/utils.ProviderStateRootProofOpts.html +++ /dev/null @@ -1,5 +0,0 @@ -ProviderStateRootProofOpts | API Documentation

    Type alias ProviderStateRootProofOpts

    ProviderStateRootProofOpts: {
        providerApi: ApiPromise;
        providerBlockHeight?: BN;
        relayApi: ApiPromise;
    }

    The options object provided when generating a Provider state proof.

    -

    Type declaration

    • providerApi: ApiPromise

      The ApiPromise instance for the provider chain.

      -
    • Optional providerBlockHeight?: BN

      The block number on the provider chain to use for the state proof. If not provided, the latest finalized block number is used.

      -
    • relayApi: ApiPromise

      The ApiPromise instance for the relay chain.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/runtime.dipProviderCalls.html b/variables/runtime.dipProviderCalls.html deleted file mode 100644 index d31693b..0000000 --- a/variables/runtime.dipProviderCalls.html +++ /dev/null @@ -1 +0,0 @@ -dipProviderCalls | API Documentation

    Variable dipProviderCallsConst

    dipProviderCalls: DefinitionsCall = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/utils.defaultValues.html b/variables/utils.defaultValues.html deleted file mode 100644 index b9fed84..0000000 --- a/variables/utils.defaultValues.html +++ /dev/null @@ -1 +0,0 @@ -defaultValues | API Documentation

    Variable defaultValuesConst

    defaultValues: {
        accountIdRuntimeType: string;
        blockNumberRuntimeType: string;
        identityDetailsRuntimeType: string;
        includeWeb3Name: boolean;
        linkedAccounts: never[];
    } = ...

    Type declaration

    • accountIdRuntimeType: string
    • blockNumberRuntimeType: string
    • identityDetailsRuntimeType: string
    • includeWeb3Name: boolean
    • linkedAccounts: never[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file