Merge pull request #3 from smartcontractkit/fix/storageSlotId-slotId

Author: KuphJr

.changeset/smart-impalas-compare.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/functions-toolkit': patch
+---
+
+Renamed storageSlotId to slotId for SecretsManager.uploadEncryptedSecretsToDON()

README.md

@@ -340,7 +340,7 @@ const encryptedSecrets = await secretsManager.encryptSecrets({
 
 Encrypted secrets can be uploaded directly to the DON via gateway URLs such that they can be used when making an on-chain request. This is accomplished by sending a signed POST request to gateway URLs which are connected to the DON. The DON then maintains a decentralized database with eventual consistency, such that the stored values will propagate to all DON nodes. To ensure redundancy, it is always recommended to send encrypted secrets storage requests to multiple gateway URLs.
 
-First, encrypt the secrets with [`encryptSecrets()`](#encrypting-secrets). Then, pass the `encryptedSecrets` hex string in an object to the `uploadEncryptedSecretsToDON()` method as shown below. The `storageSlotId` can be any integer value of zero or greater, however using a previously used slot ID will overwrite the existing data. After `minutesUntilExpiration`, the entry will be deleted from all DON nodes. Get the list of valid gateway URLs for each blockchain network from the [Chainlink Functions documentation](https://docs.chain.link/chainlink-functions/supported-networks).
+First, encrypt the secrets with [`encryptSecrets()`](#encrypting-secrets). Then, pass the `encryptedSecrets` hex string in an object to the `uploadEncryptedSecretsToDON()` method as shown below. The `slotId` can be any integer value of zero or greater, however using a previously used slot ID will overwrite the existing data. After `minutesUntilExpiration`, the entry will be deleted from all DON nodes. Get the list of valid gateway URLs for each blockchain network from the [Chainlink Functions documentation](https://docs.chain.link/chainlink-functions/supported-networks).
 
 ```
 const encryptedSecretsObj = await secretsManager.encryptSecrets({ my: 'secret' })
@@ -353,7 +353,7 @@ const {
 } = await secretsManager.uploadEncryptedSecretsToDON({
   encryptedSecretsHexstring: encryptedSecretsObj.encryptedSecrets,
   gatewayUrls: [ 'https://exampleGatewayUrl1.com/gateway', 'https://exampleGatewayUrl2.com/gateway', ... ],
-  storageSlotId: mySlotIdNumber,
+  slotId: mySlotIdNumber,
   minutesUntilExpiration: myExpirationTimeInMinutes,
 })
 ```

src/SecretsManager.ts

@@ -186,12 +186,12 @@ export class SecretsManager {
   public async uploadEncryptedSecretsToDON({
     encryptedSecretsHexstring,
     gatewayUrls,
-    storageSlotId,
+    slotId,
     minutesUntilExpiration,
   }: {
     encryptedSecretsHexstring: string
     gatewayUrls: string[]
-    storageSlotId: number
+    slotId: number
     minutesUntilExpiration: number
   }): Promise<{ version: number; success: boolean }> {
     this.isInitialized()
@@ -201,8 +201,8 @@ export class SecretsManager {
       throw Error('encryptedSecretsHexstring must be a valid hex string')
     }
 
-    if (!Number.isInteger(storageSlotId) || storageSlotId < 0) {
-      throw Error('storageSlotId must be a integer of at least 0')
+    if (!Number.isInteger(slotId) || slotId < 0) {
+      throw Error('slotId must be a integer of at least 0')
     }
 
     if (!Number.isInteger(minutesUntilExpiration) || minutesUntilExpiration < 5) {
@@ -219,7 +219,7 @@ export class SecretsManager {
 
     const message = {
       address: signerAddressBase64,
-      slotid: storageSlotId,
+      slotid: slotId,
       payload: encryptedSecretsBase64,
       version: secretsVersion,
       expiration: secretsExpiration,
@@ -228,7 +228,7 @@ export class SecretsManager {
     const storageSignatureBase64 = Buffer.from(storageSignature.slice(2), 'hex').toString('base64')
 
     const payload = {
-      slot_id: storageSlotId,
+      slot_id: slotId,
       version: secretsVersion,
       payload: encryptedSecretsBase64,
       expiration: secretsExpiration,

test/integration/integration.test.ts

@@ -1567,7 +1567,7 @@ describe('Functions toolkit classes', () => {
             'https://dongateway.com/uploadSuccess1',
             'https://dongateway.com/uploadSuccess2',
           ],
-          storageSlotId: 0,
+          slotId: 0,
           minutesUntilExpiration: 10,
         })
 
@@ -1584,7 +1584,7 @@ describe('Functions toolkit classes', () => {
         const result = await sm.uploadEncryptedSecretsToDON({
           encryptedSecretsHexstring: '0xaaaa',
           gatewayUrls: ['https://dongateway.com/1NodeFail'],
-          storageSlotId: 0,
+          slotId: 0,
           minutesUntilExpiration: 10,
         })
 
@@ -1603,7 +1603,7 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: '0xaaaa',
               gatewayUrls: ['https://dongateway.com/allNodeFail'],
-              storageSlotId: 0,
+              slotId: 0,
               minutesUntilExpiration: 10,
             }),
         ).rejects.toThrow(/All nodes failed to store the encrypted secrets/)
@@ -1618,7 +1618,7 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: '0xaaaa',
               gatewayUrls: [],
-              storageSlotId: 0,
+              slotId: 0,
               minutesUntilExpiration: 10,
             }),
         ).rejects.toThrow(/gatewayUrls must be a non-empty array of strings/)
@@ -1633,7 +1633,7 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: '0xaaaa',
               gatewayUrls: ['Invalid URL'],
-              storageSlotId: 0,
+              slotId: 0,
               minutesUntilExpiration: 10,
             }),
         ).rejects.toThrow(/is not a valid URL/)
@@ -1648,7 +1648,7 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: 'aaaa',
               gatewayUrls: ['https://dongateway.com/uploadSuccess1'],
-              storageSlotId: 0,
+              slotId: 0,
               minutesUntilExpiration: 10,
             }),
         ).rejects.toThrow(/encryptedSecretsHexstring must be a valid hex string/)
@@ -1663,10 +1663,10 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: '0xaaaa',
               gatewayUrls: ['https://dongateway.com/uploadSuccess1'],
-              storageSlotId: -1,
+              slotId: -1,
               minutesUntilExpiration: 10,
             }),
-        ).rejects.toThrow(/storageSlotId must be a integer of at least 0/)
+        ).rejects.toThrow(/slotId must be a integer of at least 0/)
       })
 
       it('Throws error for invalid expiration', async () => {
@@ -1678,7 +1678,7 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: '0xaaaa',
               gatewayUrls: ['https://dongateway.com/uploadSuccess1'],
-              storageSlotId: 0,
+              slotId: 0,
               minutesUntilExpiration: 4,
             }),
         ).rejects.toThrow(/minutesUntilExpiration must be an integer of at least 5/)
@@ -1695,7 +1695,7 @@ describe('Functions toolkit classes', () => {
             await sm.uploadEncryptedSecretsToDON({
               encryptedSecretsHexstring: '0xaaaa',
               gatewayUrls: ['https://dongateway.com/uploadSuccess1', 'https://dongateway.com/fail'],
-              storageSlotId: 0,
+              slotId: 0,
               minutesUntilExpiration: 10,
             }),
         ).rejects.toThrow(